From: Andrew Bartlett <abartlet@samba.org>
Date: Tue, 16 Jun 2020 21:25:17 +0000 (+1200)
Subject: docs: Add caution against extending this list
X-Git-Tag: ldb-2.2.0~94
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d1b6ddcd0a1cee2eaeed5cc8bb38a8e8cdc1891;p=thirdparty%2Fsamba.git

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 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',