[2597] Some changes to messages and documentation

doc/guide/bind10-guide.xml

@@ -3495,19 +3495,20 @@ const std::string HARDCODED_DOMAIN_NAME = "isc.example.com";</screen>
 
     <section id="dhcp4-serverid">
       <title>Server Identifier in DHCPv4</title>
-      <para>DHCPv4 protocol uses server identifier for clients to be able
-      to discriminate between several servers present on the same link.
-      This value is an IPv4 address of the server. Server will automatically
-      use one of its IPv4 address as its server-id and will store it to
-      a b10-dhcp4-serverid file. Location of that file is dependant on the
-      parameters specified during source configuration (see --localstatedir
-      parameter passed to configure). This file will be created during first
-      server run and will be read from that file during consecutive starts.
+      <para>The DHCPv4 protocol uses a "server identifier" for clients to be able
+      to discriminate between several servers present on the same link: this
+      value is an IPv4 address of the server. When started for the first time,
+      the DHCPv4 server will choose one of its IPv4 addresses as its server-id,
+      and store the chosen value to a file. (The file is named b10-dhcp4-serverid and is
+      stored in the "local state directory".  This is set during installation
+      when "configure" is run, and can be changed by using "--localstatedir"
+      on the "configure" command line.)  That file will be read by the server
+      and the contained value used whenever the server is subsequently started.
       </para>
       <para>
         It is unlikely that this parameter needs to be changed. If such a need
-        arises, please stop the server, edit the file and start the server
-        again. It is a text file that should contain an IPv4 address. Spaces are
+        arises, please stop the server, edit the file and restart the server.
+        It is a text file that should contain an IPv4 address. Spaces are
         ignored.  No extra characters are allowed in this file.
       </para>
     </section>
@@ -3858,16 +3859,18 @@ Dhcp6/subnet6	         []     list    (default)</screen>
 
     <section id="dhcp6-serverid">
       <title>Server Identifier in DHCPv6</title>
-      <para>DHCPv6 protocol uses server identifier (DUID) for clients to be able
-      to discriminate between several servers present on the same link.  There
-      are several types of DUIDs currently defined, but RFC3315 instructs the
-      servers to use DUID-LLT if possible. This format consists of a link-layer
-      (MAC) address and a timestamp. Server will generate automatically such a
-      DUID and will store it to a b10-dhcp6-serverid file. Location of that file
-      is dependant on the parameters specified during source configuration (see
-      --localstatedir parameter passed to configure). This file will be created
-      during first server run and will be read from that file during consecutive
-      starts.
+      <para>The DHCPv6 protocol uses a "server identifier" (also known
+      as a DUID) for clients to be able to discriminate between several
+      servers present on the same link.  There are several types of
+      DUIDs defined, but RFC 3315 instructs servers to use DUID-LLT if
+      possible. This format consists of a link-layer (MAC) address and a
+      timestamp. When started for the first time, the DHCPv6 server will
+      automatically generate such a DUID and store the chosen value to
+      a file (The file is named b10-dhcp6-serverid and is stored in the
+      "local state directory".  This is set during installation when
+      "configure" is run, and can be changed by using "--localstatedir"
+      on the "configure" command line.)  That file will be read by the server
+      and the contained value used whenever the server is subsequently started.
       </para>
       <para>
         It is unlikely that this parameter needs to be changed. If such a need

src/bin/dhcp4/dhcp4_messages.mes

@@ -162,23 +162,25 @@ A debug message listing the data returned to the client.
 The IPv4 DHCP server has encountered a fatal error and is terminating.
 The reason for the failure is included in the message.
 
-% DHCP4_SERVERID_GENERATED Server-id %1 has been generated and will be stored in %2
-This informational messages indicates that the server was not able to read
-its server identifier and has generated a new one. This server-id will
-be stored in a file and will be read and used during next restart. It is normal
-behavior when the server is started for the first time. If this message is printed
-every start, please check that the server have sufficient permission to write its
-duid file and that the duid file is not corrupted.
-
-% DHCP4_SERVERID_LOADED Server-id %1 has been loaded from file %2
+% DHCP4_SERVERID_GENERATED server-id %1 has been generated and will be stored in %2
+This informational messages indicates that the server was not able to
+read its server identifier and has generated a new one. This server-id
+will be stored in a file and will be read (and used) whenever the server
+is restarted. This is normal behavior when the server is started for the
+first time. If this message is printed every time the server is started,
+please check that the server has sufficient permission to write its
+server-id file and that the file is not corrupt.
+
+% DHCP4_SERVERID_LOADED server-id %1 has been loaded from file %2
 This debug message indicates that the server loaded its server identifier.
-That value is sent in all server responses and clients use it to discriminate
-between servers. This is a part of normal startup or reconfiguration procedure.
-
-% DHCP4_SERVERID_WRITE_FAIL server was not able to write its duid to file %1
-This warning message indicates that server was not able to write its server identifier
-(DUID) to a file. This likely indicates lack of write permission to a given
-file or directory.
+That value is sent in all server responses and clients use it to
+discriminate between servers. This is a part of normal startup or
+reconfiguration procedure.
+
+% DHCP4_SERVERID_WRITE_FAIL server was not able to write its ID to file %1
+This warning message indicates that server was not able to write its
+server identifier to a file. The most likely cause is is that the server
+does not have permissions to write the server id file.
 
 % DHCP4_SESSION_FAIL failed to establish BIND 10 session (%1), running stand-alone
 The server has failed to establish communication with the rest of BIND

src/bin/dhcp6/dhcp6_messages.mes

@@ -194,28 +194,33 @@ A debug message listing the data returned to the client.
 The IPv6 DHCP server has encountered a fatal error and is terminating.
 The reason for the failure is included in the message.
 
-% DHCP6_SERVERID_GENERATED Server-id %1 has been generated and will be stored in %2
+% DHCP6_SERVERID_GENERATED server-id %1 has been generated and will be stored in %2
 This informational messages indicates that the server was not able to read
-its server identifier (DUID) and has generated a new one. This server-id will
-be stored in a file and will be read and used during next restart. It is normal
-behavior when the server is started for the first time. If this message is printed
-every start, please check that the server have sufficient permission to write its
-duid file and that the duid file is not corrupted. Changing server identifier in
-a production environment is not desired as clients will not recognize the server
-and may go through rebind phase. They still should be able to recover without loosing
-their leases.
-
-% DHCP6_SERVERID_LOADED Server-id %1 has been loaded from file %2
+its server identifier (DUID) and has generated a new one. This server-id
+will be stored in a file and will be read and used during next restart. It
+is normal behavior when the server is started for the first time. If
+this message is printed every start, please check that the server have
+sufficient permission to write its server-id file and that the file is not
+corrupt.
+
+Changing the server identifier in a production environment is not
+recommended as existing clients will not recognize the server and may go
+through a rebind phase. However, they should be able to recover without
+losing their leases.
+
+% DHCP6_SERVERID_LOADED server-id %1 has been loaded from file %2
 This debug message indicates that the server loaded its server identifier.
-That value is sent in all server responses and clients use it to discriminate
-between servers. This is a part of normal startup or reconfiguration procedure.
-
-% DHCP6_SERVERID_WRITE_FAIL server was not able to write its duid to file %1
-This warning message indicates that server was not able to write its server identifier
-(DUID) to a file. This likely indicates lack of write permission to a given
-file or directory. This is not cricital and the server will continue to operate,
-but server will generate different DUID during every start and clients will
-need to go through rebind phase to recover.
+That value is sent in all server responses and clients use it to
+discriminate between servers. This is a part of normal startup or
+reconfiguration procedure.
+
+% DHCP6_SERVERID_WRITE_FAIL server was not able to write its ID to file %1
+This warning message indicates that server was not able to write its
+server identifier (DUID) to a file. This likely indicates lack of write
+permission to a given file or directory. This is not cricital and the
+server will continue to operate, but server will generate different DUID
+during every start and clients will need to go through a rebind phase
+to recover.
 
 % DHCP6_SESSION_FAIL failed to establish BIND 10 session (%1), running stand-alone
 The server has failed to establish communication with the rest of BIND