Browse Source

[1704] Changes to documentation regarding jumbled up messages

Logging output from different processes can get jumbled up if written
to stderr (because messages are output in multiple write(2) operations.)
This change updates the documentation to suggest that the user switch
to stdout if that happens.
Stephen Morris 13 years ago
parent
commit
95410c8037
2 changed files with 197 additions and 88 deletions
  1. 182 82
      doc/guide/bind10-guide.html
  2. 15 6
      doc/guide/bind10-guide.xml

File diff suppressed because it is too large
+ 182 - 82
doc/guide/bind10-guide.html


+ 15 - 6
doc/guide/bind10-guide.xml

@@ -2809,34 +2809,43 @@ TODO; there's a ticket to determine these levels, see #1074
           <varlistentry>
             <term><option>destination</option> is <quote>console</quote></term>
             <listitem>
-              <simpara>
+              <para>
                  The value of output must be one of <quote>stdout</quote>
                  (messages printed to standard output) or
                  <quote>stderr</quote> (messages printed to standard
                  error).
-              </simpara>
+              </para>
+              <para>
+                Note: if output is set to <quote>stderr</quote> and a lot of
+                messages are produced in a short time (e.g. if the logging
+                level is set to DEBUG), you may occasionally see some messages
+                jumbled up together.  This is a due to a combination of the way
+                that messages are written to the screen and the unbuffered
+                nature of the standard error stream.  If this occurs, it is
+                recommended that output be set to <quote>stdout</quote>.
+              </para>
             </listitem>
           </varlistentry>
 
           <varlistentry>
             <term><option>destination</option> is <quote>file</quote></term>
             <listitem>
-              <simpara>
+              <para>
                 The value of output is interpreted as a file name;
                 log messages will be appended to this file.
-              </simpara>
+              </para>
             </listitem>
           </varlistentry>
 
           <varlistentry>
             <term><option>destination</option> is <quote>syslog</quote></term>
             <listitem>
-              <simpara>
+              <para>
                 The value of output is interpreted as the
                 <command>syslog</command> facility (e.g.
                 <emphasis>local0</emphasis>) that should be used
                 for log messages.
-              </simpara>
+              </para>
             </listitem>
           </varlistentry>