Browse Source

[1545] Minor changes as suggested by review

Stephen Morris 12 years ago
parent
commit
23ba7abb4e

+ 3 - 3
src/bin/dhcp4/dhcp4_messages.mes

@@ -40,7 +40,7 @@ server is about to open sockets on the specified port.
 
 
 % DHCP4_PACKET_PARSE_FAIL failed to parse incoming packet: %1
 % DHCP4_PACKET_PARSE_FAIL failed to parse incoming packet: %1
 The IPv4 DHCP server has received a packet that it is unable to
 The IPv4 DHCP server has received a packet that it is unable to
-interpret. The reason why the packet is invalid is include in the message.
+interpret. The reason why the packet is invalid is included in the message.
 
 
 % DHCP4_PACKET_RECEIVED %1 (type %2) packet received on interface %3
 % DHCP4_PACKET_RECEIVED %1 (type %2) packet received on interface %3
 A debug message noting that the server has received the specified type of
 A debug message noting that the server has received the specified type of
@@ -50,8 +50,8 @@ may well be a valid DHCP packet, just a type not expected by the server
 
 
 % DHCP4_PACK_FAIL failed to assemble response correctly
 % DHCP4_PACK_FAIL failed to assemble response correctly
 This error is output if the server failed to assemble the data to be
 This error is output if the server failed to assemble the data to be
-returned to the client into a valid packet.  Additional messages will
-detail the reason.
+returned to the client into a valid packet.  The cause is most likely
+to be a programming error: please raise a bug report.
 
 
 % DHCP4_QUERY_DATA received packet type %1, data is <%2>
 % DHCP4_QUERY_DATA received packet type %1, data is <%2>
 A debug message listing the data received from the client.
 A debug message listing the data received from the client.

+ 5 - 5
src/bin/dhcp4/dhcp4_srv.h

@@ -44,7 +44,7 @@ class Dhcpv4Srv : public boost::noncopyable {
     public:
     public:
     /// @brief Default constructor.
     /// @brief Default constructor.
     ///
     ///
-    /// Instantiates necessary services, required to run DHCPv6 server.
+    /// Instantiates necessary services, required to run DHCPv4 server.
     /// In particular, creates IfaceMgr that will be responsible for
     /// In particular, creates IfaceMgr that will be responsible for
     /// network interaction. Will instantiate lease manager, and load
     /// network interaction. Will instantiate lease manager, and load
     /// old or create new DUID. It is possible to specify alternate
     /// old or create new DUID. It is possible to specify alternate
@@ -54,7 +54,7 @@ class Dhcpv4Srv : public boost::noncopyable {
     /// @param port specifies port number to listen on
     /// @param port specifies port number to listen on
     Dhcpv4Srv(uint16_t port = DHCP4_SERVER_PORT);
     Dhcpv4Srv(uint16_t port = DHCP4_SERVER_PORT);
 
 
-    /// @brief Destructor. Used during DHCPv6 service shutdown.
+    /// @brief Destructor. Used during DHCPv4 service shutdown.
     ~Dhcpv4Srv();
     ~Dhcpv4Srv();
 
 
     /// @brief Main server processing loop.
     /// @brief Main server processing loop.
@@ -75,7 +75,7 @@ class Dhcpv4Srv : public boost::noncopyable {
     /// Returns the name of valid packet received by the server (e.g. DISCOVER).
     /// Returns the name of valid packet received by the server (e.g. DISCOVER).
     /// If the packet is unknown - or if it is a valid DHCP packet but not one
     /// If the packet is unknown - or if it is a valid DHCP packet but not one
     /// expected to be received by the server (such as an OFFER), the string
     /// expected to be received by the server (such as an OFFER), the string
-    /// "UNKNOWN" is returned.  This methos is used in debug messages.
+    /// "UNKNOWN" is returned.  This method is used in debug messages.
     ///
     ///
     /// As the operation of the method does not depend on any server state, it
     /// As the operation of the method does not depend on any server state, it
     /// is declared static.
     /// is declared static.
@@ -106,11 +106,11 @@ protected:
     /// is valid, not expired, not reserved, not used by other client and
     /// is valid, not expired, not reserved, not used by other client and
     /// that requesting client is allowed to use it.
     /// that requesting client is allowed to use it.
     ///
     ///
-    /// Returns ACK message, NACK message, or NULL
+    /// Returns ACK message, NAK message, or NULL
     ///
     ///
     /// @param request a message received from client
     /// @param request a message received from client
     ///
     ///
-    /// @return ACK or NACK message
+    /// @return ACK or NAK message
     Pkt4Ptr processRequest(Pkt4Ptr& request);
     Pkt4Ptr processRequest(Pkt4Ptr& request);
 
 
     /// @brief Stub function that will handle incoming RELEASE messages.
     /// @brief Stub function that will handle incoming RELEASE messages.

+ 2 - 2
src/bin/dhcp6/dhcp6_messages.mes

@@ -53,8 +53,8 @@ a received OFFER packet as UNKNOWN).
 
 
 % DHCP6_PACK_FAIL failed to assemble response correctly
 % DHCP6_PACK_FAIL failed to assemble response correctly
 This error is output if the server failed to assemble the data to be
 This error is output if the server failed to assemble the data to be
-returned to the client into a valid packet.  Additional messages will
-detail the reason.
+returned to the client into a valid packet.  The reason is most likely
+to be to a programming error: please raise a bug report.
 
 
 % DHCP6_QUERY_DATA received packet length %1, data length %2, data is <%3>
 % DHCP6_QUERY_DATA received packet length %1, data length %2, data is <%3>
 A debug message listing the data received from the client or relay.
 A debug message listing the data received from the client or relay.

+ 3 - 3
src/bin/dhcp6/dhcp6_srv.h

@@ -72,10 +72,10 @@ public:
 
 
     /// @brief Return textual type of packet received by server
     /// @brief Return textual type of packet received by server
     ///
     ///
-    /// Returns the name of valid packet received by the server (e.g. DISCOVER).
+    /// Returns the name of valid packet received by the server (e.g. SOLICIT).
     /// If the packet is unknown - or if it is a valid DHCP packet but not one
     /// If the packet is unknown - or if it is a valid DHCP packet but not one
-    /// expected to be received by the server (such as an OFFER), the string
-    /// "UNKNOWN" is returned.  This methos is used in debug messages.
+    /// expected to be received by the server (such as an ADVERTISE), the string
+    /// "UNKNOWN" is returned.  This method is used in debug messages.
     ///
     ///
     /// As the operation of the method does not depend on any server state, it
     /// As the operation of the method does not depend on any server state, it
     /// is declared static.
     /// is declared static.

+ 1 - 1
src/bin/dhcp6/tests/dhcp6_srv_unittest.cc

@@ -268,4 +268,4 @@ TEST_F(Dhcpv6SrvTest, serverReceivedPacketName) {
     }
     }
 }
 }
 
 
-}   // anonymous namespace
+}   // end of anonymous namespace