summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Bartlett <abartlet@samba.org>2020-06-17 09:25:17 +1200
committerAndreas Schneider <asn@cryptomilk.org>2020-06-17 15:48:06 +0000
commit3d1b6ddcd0a1cee2eaeed5cc8bb38a8e8cdc1891 (patch)
treee3f8b1867e50d1b4cd5d1181200643c267504c8b
parent1054318827d0f043dcbebc394479b05d7ef8e87b (diff)
downloadsamba-3d1b6ddcd0a1cee2eaeed5cc8bb38a8e8cdc1891.tar.gz
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
-rw-r--r--python/samba/tests/docs.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/python/samba/tests/docs.py b/python/samba/tests/docs.py
index b0eff53386c..4b67bc2bd38 100644
--- 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',