Browse Source

[3752] Added some descriptions

Francis Dupont 9 years ago
parent
commit
52f473221f
1 changed files with 15 additions and 7 deletions
  1. 15 7
      src/lib/dhcpsrv/logging.spec

+ 15 - 7
src/lib/dhcpsrv/logging.spec

@@ -19,7 +19,8 @@
             "item_name": "name",
             "item_type": "string",
             "item_optional": false,
-            "item_default": "kea"
+            "item_default": "kea",
+            "item_description": "Logging name"
           },
 
           {
@@ -33,33 +34,38 @@
                "item_type": "map",
                "item_optional": false,
                "item_default": {},
+               "item_description": "Options for a logging destination",
                "map_item_spec": [
                {
                  "item_name": "output",
                  "item_type": "string",
                  "item_optional": false,
-                 "item_default": "stdout"
+                 "item_default": "stdout",
+                 "item_description": "Logging destination (stdout, stderr, syslog, syslog:name, file name)"
                },
 
                {
                  "item_name": "maxver",
                  "item_type": "integer",
                  "item_optional": true,
-                 "item_default": 1
+                 "item_default": 1,
+                 "item_description": "Maximum number of log files in rotation"
                },
 
                {
                  "item_name": "maxsize",
                  "item_type": "integer",
                  "item_optional": true,
-                 "item_default": 204800
+                 "item_default": 204800,
+                 "item_description": "Maximum log file size"
                },
 
                {
                  "item_name": "flush",
                  "item_type": "boolean",
                  "item_optional": true,
-                 "item_default": true
+                 "item_default": true,
+                 "item_description": "Immediate flush"
                }
                ]
              }
@@ -69,14 +75,16 @@
             "item_name": "severity",
             "item_type": "string",
             "item_optional": false,
-            "item_default": "INFO"
+            "item_default": "INFO",
+            "item_description": "Logging severity"
           },
 
           {
             "item_name": "debuglevel",
             "item_type": "integer",
             "item_optional": true,
-            "item_default": 0
+            "item_default": 0,
+            "item_description": "Debug level (for DEBUG severity, 0..99 range)"
           }
           ]
         }