2344. [bug] Improve "logging{ file ...; };" documentation.

                        [RT #17888]

diff --git a/CHANGES b/CHANGES
index 72a96b120d0061c9d015cdcec538b9dfbef01ee6..f7d68ee4d58697a2c6c33afdc47393d38951acf3 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,6 @@
+2344.  [bug]           Improve "logging{ file ...; };" documentation.
+                       [RT #17888]
+
 2343.  [bug]           (Seemingly) duplicate IPv6 entries could be
                        created in ADB. [RT #17837]
 

diff --git a/lib/isccfg/namedconf.c b/lib/isccfg/namedconf.c
index 0549518eb1011f6f3af98c31aa4c60c34743dc46..dfccba50ffe83defdb74f4a29b379cfb0e066983 100644 (file)
--- a/lib/isccfg/namedconf.c
+++ b/lib/isccfg/namedconf.c
@@ -15,7 +15,7 @@
  * PERFORMANCE OF THIS SOFTWARE.
  */
 
-/* $Id: namedconf.c,v 1.84 2008/01/22 00:29:03 jinmei Exp $ */
+/* $Id: namedconf.c,v 1.85 2008/03/27 03:30:53 marka Exp $ */
 
 /*! \file */
 
@@ -1761,6 +1761,7 @@ static isc_result_t
 parse_logversions(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
        return (parse_enum_or_other(pctx, type, &cfg_type_uint32, ret));
 }
+
 static cfg_type_t cfg_type_logversions = {
        "logversions", parse_logversions, cfg_print_ustring, cfg_doc_terminal,
        &cfg_rep_string, logversions_enums
@@ -1834,8 +1835,19 @@ print_logfile(cfg_printer_t *pctx, const cfg_obj_t *obj) {
        }
 }
 
+
+static void
+doc_logfile(cfg_printer_t *pctx, const cfg_type_t *type) {
+       UNUSED(type);
+       cfg_print_cstr(pctx, "<quoted_string>");
+       cfg_print_chars(pctx, " ", 1);
+       cfg_print_cstr(pctx, "[ versions ( \"unlimited\" | <integer> ) ]");
+       cfg_print_chars(pctx, " ", 1);
+       cfg_print_cstr(pctx, "[ size <size> ]");
+}
+
 static cfg_type_t cfg_type_logfile = {
-       "log_file", parse_logfile, print_logfile, cfg_doc_terminal,
+       "log_file", parse_logfile, print_logfile, doc_logfile,
        &cfg_rep_tuple, logfile_fields
 };
 
@@ -1866,8 +1878,8 @@ static cfg_type_t cfg_type_lwres_view = {
 };
 
 static cfg_type_t cfg_type_lwres_searchlist = {
-       "lwres_searchlist", cfg_parse_bracketed_list, cfg_print_bracketed_list, cfg_doc_bracketed_list,
-       &cfg_rep_list, &cfg_type_astring };
+       "lwres_searchlist", cfg_parse_bracketed_list, cfg_print_bracketed_list,
+       cfg_doc_bracketed_list, &cfg_rep_list, &cfg_type_astring };
 
 static cfg_clausedef_t
 lwres_clauses[] = {
@@ -1986,15 +1998,15 @@ doc_sockaddrnameport(cfg_printer_t *pctx, const cfg_type_t *type) {
        cfg_print_chars(pctx, "( ", 2);
        cfg_print_cstr(pctx, "<quoted_string>");
        cfg_print_chars(pctx, " ", 1);
-       cfg_print_cstr(pctx, "[port <integer>]");
+       cfg_print_cstr(pctx, "[ port <integer> ]");
        cfg_print_chars(pctx, " | ", 3);
        cfg_print_cstr(pctx, "<ipv4_address>");
        cfg_print_chars(pctx, " ", 1);
-       cfg_print_cstr(pctx, "[port <integer>]");
+       cfg_print_cstr(pctx, "[ port <integer> ]");
        cfg_print_chars(pctx, " | ", 3);
        cfg_print_cstr(pctx, "<ipv6_address>");
        cfg_print_chars(pctx, " ", 1);
-       cfg_print_cstr(pctx, "[port <integer>]");
+       cfg_print_cstr(pctx, "[ port <integer> ]");
        cfg_print_chars(pctx, " )", 2);
 }
 
@@ -2072,11 +2084,11 @@ doc_masterselement(cfg_printer_t *pctx, const cfg_type_t *type) {
        cfg_print_chars(pctx, " | ", 3);
        cfg_print_cstr(pctx, "<ipv4_address>");
        cfg_print_chars(pctx, " ", 1);
-       cfg_print_cstr(pctx, "[port <integer>]");
+       cfg_print_cstr(pctx, "[ port <integer> ]");
        cfg_print_chars(pctx, " | ", 3);
        cfg_print_cstr(pctx, "<ipv6_address>");
        cfg_print_chars(pctx, " ", 1);
-       cfg_print_cstr(pctx, "[port <integer>]");
+       cfg_print_cstr(pctx, "[ port <integer> ]");
        cfg_print_chars(pctx, " )", 2);
 }