docs: Add caution against extending this list

We want correct documentation if at all possible.

Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Andreas Schneider <asn@samba.org>
Autobuild-User(master): Andreas Schneider <asn@cryptomilk.org>
Autobuild-Date(master): Wed Jun 17 15:48:06 UTC 2020 on sn-devel-184

diff --git a/python/samba/tests/docs.py b/python/samba/tests/docs.py
index b0eff53386ca6ac4fd6cb2dbd03551a3f115cc25..4b67bc2bd3886ac7e26665af8b6d17e166325d0f 100644 (file)
--- a/python/samba/tests/docs.py
+++ b/python/samba/tests/docs.py
@@ -100,6 +100,9 @@ def get_documented_tuples(sourcedir, omit_no_default=True):
 class SmbDotConfTests(TestCase):
 
     # defines the cases where the defaults may differ from the documentation
+    #
+    # Please pass the default via waf rather than adding to this
+    # list if at all possible.
     special_cases = set([
         'log level',
         'path',