]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Update documentation for named's -M option
authorMichał Kępień <michal@isc.org>
Fri, 15 Jul 2022 08:23:03 +0000 (10:23 +0200)
committerMichał Kępień <michal@isc.org>
Fri, 15 Jul 2022 08:45:34 +0000 (10:45 +0200)
Add "internal" to the list of legal values for the -M command-line
option (commit 1f7d2d53f0e5b86e22e1dd116868bb69eeacb1a0 added that
flag).

Make the style of the relevant paragraph more in line with the next one
and split its contents up into an unordered list of options for improved
readability.

(cherry picked from commit f0c31ceb3ba7364aa0478adf17c43ef700270a76)

bin/named/named.rst
doc/man/named.8in

index a08e93aa357bf56bae51794ab0755156959e2f8f..818a896c8dcf98efcb6f49b78d153df1a934d160 100644 (file)
@@ -87,13 +87,23 @@ Options
    This option sets the log to the file ``logfile`` by default, instead of the system log.
 
 ``-M option``
-   This option sets the default memory context options. If set to ``external``,
-   the internal memory manager is bypassed in favor of
-   system-provided memory allocation functions. If set to ``fill``, blocks
-   of memory are filled with tag values when allocated or freed, to
-   assist debugging of memory problems. ``nofill`` disables this behavior,
-   and is the default unless ``named`` has been compiled with developer
-   options.
+
+   This option sets the default (comma-separated) memory context
+   options. The possible flags are:
+
+   - ``external``: use system-provided memory allocation functions; this
+     is the implicit default.
+
+   - ``internal``: use the internal memory manager.
+
+   - ``fill``: fill blocks of memory with tag values when they are
+     allocated or freed, to assist debugging of memory problems; this is
+     the implicit default if ``named`` has been compiled with
+     ``--enable-developer``.
+
+   - ``nofill``: disable the behavior enabled by ``fill``; this is the
+     implicit default unless ``named`` has been compiled with
+     ``--enable-developer``.
 
 ``-m flag``
    This option turns on memory usage debugging flags. Possible flags are ``usage``,
index 1430e9ce80cb81031c1b4df62d07f4c685a5c5fa..51e121bd8161655cb43c3e0ef6761cc1c469cfbe 100644 (file)
@@ -100,15 +100,32 @@ This option runs the server in the foreground and forces all logging to \fBstder
 .TP
 .B \fB\-L logfile\fP
 This option sets the log to the file \fBlogfile\fP by default, instead of the system log.
-.TP
-.B \fB\-M option\fP
-This option sets the default memory context options. If set to \fBexternal\fP,
-the internal memory manager is bypassed in favor of
-system\-provided memory allocation functions. If set to \fBfill\fP, blocks
-of memory are filled with tag values when allocated or freed, to
-assist debugging of memory problems. \fBnofill\fP disables this behavior,
-and is the default unless \fBnamed\fP has been compiled with developer
-options.
+.UNINDENT
+.sp
+\fB\-M option\fP
+.INDENT 0.0
+.INDENT 3.5
+This option sets the default (comma\-separated) memory context
+options. The possible flags are:
+.INDENT 0.0
+.IP \(bu 2
+\fBexternal\fP: use system\-provided memory allocation functions; this
+is the implicit default.
+.IP \(bu 2
+\fBinternal\fP: use the internal memory manager.
+.IP \(bu 2
+\fBfill\fP: fill blocks of memory with tag values when they are
+allocated or freed, to assist debugging of memory problems; this is
+the implicit default if \fBnamed\fP has been compiled with
+\fB\-\-enable\-developer\fP\&.
+.IP \(bu 2
+\fBnofill\fP: disable the behavior enabled by \fBfill\fP; this is the
+implicit default unless \fBnamed\fP has been compiled with
+\fB\-\-enable\-developer\fP\&.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
 .TP
 .B \fB\-m flag\fP
 This option turns on memory usage debugging flags. Possible flags are \fBusage\fP,