From 06d9fc80c411882576240a76e96c56f767b14463 Mon Sep 17 00:00:00 2001 From: "Jason A. Donenfeld" Date: Sun, 7 Oct 2018 16:29:58 +0200 Subject: allowedips: document additional nobs --- src/selftest/allowedips.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src') diff --git a/src/selftest/allowedips.c b/src/selftest/allowedips.c index a9d2c3a..3b095d0 100644 --- a/src/selftest/allowedips.c +++ b/src/selftest/allowedips.c @@ -1,6 +1,18 @@ // SPDX-License-Identifier: GPL-2.0 /* * Copyright (C) 2015-2018 Jason A. Donenfeld . All Rights Reserved. + * + * This contains some basic static unit tests for the allowedips data structure. + * It also has two additional modes that are disabled and meant to be used by + * folks directly playing with this file. If you define the macro + * DEBUG_PRINT_TRIE_GRAPHVIZ to be 1, then every time there's a full tree in + * memory, it will be printed out as KERN_DEBUG in a format that can be passed + * to graphviz (the dot command) to visualize it. If you define the macro + * DEBUG_RANDOM_TRIE to be 1, then there will be an extremely costly set of + * randomized tests done against a trivial implementation, which may take + * upwards of a half-hour to complete. There's no set of users who should be + * enabling these, and the only developers that should go anywhere near these + * nobs are the ones who are reading this comment. */ #ifdef DEBUG -- cgit v1.2.3-59-g8ed1b