Clarified what the SWAT FLAGS mean and what they do.

Note: The comments in this file regarding the FLAGS has been in need of
maintenance for some time.
(This used to be commit a0d2fa0f25abe22008080df2ad2e58e7ee424a2b)

diff --git a/source3/include/smb.h b/source3/include/smb.h
index 9800e21dff75aa4ea13b1c9743fae93081acb4c0..f586b6f1a496e7d82ae9db829c94b922b30b6ddd 100644 (file)
--- a/source3/include/smb.h
+++ b/source3/include/smb.h
@@ -705,13 +705,15 @@ struct bitmap {
        unsigned int n;
 };
 
-#define FLAG_BASIC     0x0001 /* fundamental options */
+/* Note: Parameters flagged as basic will be visible in all views. */
+/*       Parameters NOT flagged as basic will not be preset to default value is not set in smb.conf */
+#define FLAG_BASIC     0x0001 /* fundamental options preset to default value if not set in smb.conf */
 #define FLAG_SHARE     0x0002 /* file sharing options */
 #define FLAG_PRINT     0x0004 /* printing options */
 #define FLAG_GLOBAL    0x0008 /* local options that should be globally settable in SWAT */
 #define FLAG_WIZARD    0x0010 /* Parameters that the wizard will operate on */
-#define FLAG_ADVANCED  0x0020 /* Parameters that the wizard will operate on */
-#define FLAG_DEVELOPER         0x0040 /* Parameters that the wizard will operate on */
+#define FLAG_ADVANCED  0x0020 /* Parameters that will be visible in advanced view and developer view */
+#define FLAG_DEVELOPER         0x0040 /* Parameters that will be visible only in developer view */
 #define FLAG_DEPRECATED 0x1000 /* options that should no longer be used */
 #define FLAG_HIDE      0x2000 /* options that should be hidden in SWAT */
 #define FLAG_DOS_STRING 0x4000 /* convert from UNIX to DOS codepage when reading this string. */