Documentation update
authorWouter Verhelst <w@uter.be>
Thu, 9 Jul 2009 08:51:09 +0000 (10:51 +0200)
committerWouter Verhelst <w@uter.be>
Thu, 9 Jul 2009 08:51:09 +0000 (10:51 +0200)
People are sometimes confused about the warnings that nbd-server
produces when an invalid or incomplete warning is encountered.

Note in the manpage that these warnings are harmless if a command-line
configuration was specified and no configuration file is desired.

nbd-server.1.in
nbd-server.1.sgml

index d868ae0..bcecfba 100644 (file)
@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "NBD-SERVER" "1" "23 May 2009" "" ""
+.TH "NBD-SERVER" "1" "09 July 2009" "" ""
 
 .SH NAME
 nbd-server \- serve a file as a block device to other computers    running the GNU/Linux(tm) or GNU/Hurd Operating    System
@@ -99,6 +99,12 @@ specified on the command line. To disable the configuration
 file entirely, either move it away or use the -C option to
 point \fBnbd-server\fR(1) to a non-existing or
 empty configuration file.
+
+Also note that if an empty, incomplete, or invalid
+configuration file is specified, nbd-server will produce a
+warning about failure to parse the config file. If the
+command line contains a fully specified configuration, this
+warning is harmless and may be ignored.
 .TP
 \fBhost list filename\fR
 This argument should contain a list of IP-addresses
index 81b235a..a492875 100644 (file)
@@ -183,6 +183,11 @@ manpage.1: manpage.sgml
            file entirely, either move it away or use the -C option to
            point <command>nbd-server</command>(1) to a non-existing or
            empty configuration file.</para>
+         <para>Also note that if an empty, incomplete, or invalid
+           configuration file is specified, nbd-server will produce a
+           warning about failure to parse the config file. If the
+           command line contains a fully specified configuration, this
+           warning is harmless and may be ignored.</para>
        </listitem>
       </varlistentry>
       <varlistentry>