From: Suzanne Goldlust Date: Mon, 16 Nov 2020 15:28:04 +0000 (+0000) Subject: Fix typos in documentation X-Git-Tag: Kea-1.9.2~26 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dcefadd1c2745ea368d78162c84a5efa0637bd03;p=thirdparty%2Fkea.git Fix typos in documentation Correcting typos and minor text errors throughout the Kea Messages docs --- diff --git a/src/bin/dhcp4/dhcp4_messages.cc b/src/bin/dhcp4/dhcp4_messages.cc index 06b906b164..405188e7e1 100644 --- a/src/bin/dhcp4/dhcp4_messages.cc +++ b/src/bin/dhcp4/dhcp4_messages.cc @@ -216,7 +216,7 @@ const char* values[] = { "DHCP4_DYNAMIC_RECONFIGURATION_FAIL", "dynamic server reconfiguration failed with file: %1", "DHCP4_EMPTY_HOSTNAME", "%1: received empty hostname from the client, skipping processing of this option", "DHCP4_FLEX_ID", "flexible identifier generated for incoming packet: %1", - "DHCP4_GENERATE_FQDN", "%1: client did not send a FQDN or hostname; FQDN will be be generated for the client", + "DHCP4_GENERATE_FQDN", "%1: client did not send a FQDN or hostname; FQDN will be generated for the client", "DHCP4_HANDLE_SIGNAL_EXCEPTION", "An exception was thrown while handing signal: %1", "DHCP4_HOOKS_LIBS_RELOAD_FAIL", "reload of hooks libraries failed", "DHCP4_HOOK_BUFFER_RCVD_DROP", "received buffer from %1 to %2 over interface %3 was dropped because a callout set the drop flag", diff --git a/src/bin/dhcp4/dhcp4_messages.mes b/src/bin/dhcp4/dhcp4_messages.mes index cb1c4d33d8..afcfffae27 100644 --- a/src/bin/dhcp4/dhcp4_messages.mes +++ b/src/bin/dhcp4/dhcp4_messages.mes @@ -205,7 +205,7 @@ has been lost and an automatic attempt to reconnect has failed. % DHCP4_DB_RECONNECT_ATTEMPT_SCHEDULE scheduling attempt %1 of %2 in %3 milliseconds An informational message indicating that the server is scheduling the next attempt to reconnect to its lease and/or host databases. This occurs when the -server has lost databse connectivity and is attempting to reconnect +server has lost database connectivity and is attempting to reconnect automatically. % DHCP4_DB_RECONNECT_DISABLED database reconnect is disabled: max-reconnect-tries %1, reconnect-wait-time %2 @@ -214,8 +214,8 @@ lease or host database or both and that automatic reconnect is not enabled. % DHCP4_DB_RECONNECT_NO_DB_CTL unexpected error in database reconnect This is an error message indicating a programmatic error that should not -occur. It will prohibit the server from attempting to reconnect to its -databases if connectivy is lost, and the server will exit. This error +occur. It prohibits the server from attempting to reconnect to its +databases if connectivity is lost, and the server exits. This error should be reported. % DHCP4_DB_RECONNECT_RETRIES_EXHAUSTED maximum number of database reconnect attempts: %1, has been exhausted without success, server is shutting down! @@ -235,7 +235,7 @@ used to receive DHCPv4 traffic. Sockets on this interface will not be opened by the Interface Manager until interface is enabled. % DHCP4_DECLINE_FAIL %1: error on decline lease for address %2: %3 -This error message indicates that the software failed to deline a +This error message indicates that the software failed to decline a lease from the lease database due to an error during a database operation. The first argument includes the client and the transaction identification information. The second argument holds the IPv4 address @@ -333,7 +333,7 @@ and the expression specified in its configuration generated (was evaluated to) an identifier for incoming packet. This debug message is mainly intended as a debugging assistance for flexible identifier. -% DHCP4_GENERATE_FQDN %1: client did not send a FQDN or hostname; FQDN will be be generated for the client +% DHCP4_GENERATE_FQDN %1: client did not send a FQDN or hostname; FQDN will be generated for the client This debug message is issued when the server did not receive a Hostname option from the client and hostname generation is enabled. This provides a means to create DNS entries for unsophisticated clients. diff --git a/src/bin/dhcp6/dhcp6_messages.mes b/src/bin/dhcp6/dhcp6_messages.mes index 29374f258b..1cb32ce2d5 100644 --- a/src/bin/dhcp6/dhcp6_messages.mes +++ b/src/bin/dhcp6/dhcp6_messages.mes @@ -155,7 +155,7 @@ has been lost and an automatic attempt to reconnect has failed. % DHCP6_DB_RECONNECT_ATTEMPT_SCHEDULE scheduling attempt %1 of %2 in %3 milliseconds An informational message indicating that the server is scheduling the next attempt to reconnect to its lease and/or host databases. This occurs when the -server has lost databse connectivity and is attempting to reconnect +server has lost database connectivity and is attempting to reconnect automatically. % DHCP6_DB_RECONNECT_DISABLED database reconnect is disabled: max-reconnect-tries %1, reconnect-wait-time %2 @@ -164,8 +164,8 @@ lease or host database or both and that automatic reconnect is not enabled. % DHCP6_DB_RECONNECT_NO_DB_CTL unexpected error in database reconnect This is an error message indicating a programmatic error that should not -occur. It will prohibit the server from attempting to reconnect to its -databases if connectivy is lost, and the server will exit. This error +occur. It prohibits the server from attempting to reconnect to its +databases if connectivity is lost, and the server exits. This error should be reported. % DHCP6_DB_RECONNECT_RETRIES_EXHAUSTED maximum number of database reconnect attempts: %1, has been exhausted without success, server is shutting down! @@ -208,7 +208,7 @@ includes the received FQDN. % DHCP6_DDNS_REMOVE_OLD_LEASE_FQDN %1: FQDN for a lease: %2 has changed. New values: hostname = %3, reverse mapping = %4, forward mapping = %5 This debug message is logged during lease renewal when an old lease that is -no longer being offered has a different FQDN than the renewing lesae. Thus +no longer being offered has a different FQDN than the renewing lease. Thus the old DNS entries need to be removed. The first argument includes the client and the transaction identification information. The second argument holds the details about the lease for which the FQDN information and/or mappings have @@ -238,7 +238,7 @@ used to receive DHCPv6 traffic. Sockets on this interface will not be opened by the Interface Manager until interface is enabled. % DHCP6_DECLINE_FAIL %1: error on decline lease for address %2: %3 -This error message indicates that the software failed to deline a +This error message indicates that the software failed to decline a lease from the lease database due to an error during a database operation. The first argument includes the client and the transaction identification information. The second argument holds the IPv6 address @@ -685,7 +685,7 @@ message, the server successfully renewed a prefix lease. This is a normal behavior and indicates successful operation. The first argument includes the client and transaction identification information. The remaining arguments hold the allocated prefix, -prefix length and and IAID. +prefix length and IAID. % DHCP6_PROCESS_IA_NA_EXTEND %1: extending lease lifetime for IA_NA option with iaid=%2 This message is logged when the server is starting to extend the lifetime diff --git a/src/hooks/dhcp/high_availability/ha_messages.mes b/src/hooks/dhcp/high_availability/ha_messages.mes index 38bb5ff54f..995bc26436 100644 --- a/src/hooks/dhcp/high_availability/ha_messages.mes +++ b/src/hooks/dhcp/high_availability/ha_messages.mes @@ -311,7 +311,7 @@ client's DHCP message will be dropped. % HA_LEASE_UPDATE_CREATE_UPDATE_FAILED_ON_PEER %1: failed to create or update the lease having type %2 for address %3, reason: %4 This informational message is issued when one of the leases failed to be -created or updated on the HA peer whilw processing the lease updates sent +created or updated on the HA peer while processing the lease updates sent from this server. This may indicate an issue with communication between the peer and its lease database. @@ -384,9 +384,9 @@ failure. % HA_MAINTENANCE_SHUTDOWN_SAFE the server can now be shutdown for maintenance as the partner has taken over the DHCP traffic This informational message is displayed after the server transitions to the in-maintenance state. This server no longer responds to any DHCP queries and its -partner being in the partner-in-maintenance state has taken over the DHCP traffic. -When the server in-maintenance state is shut down, the partner will move to -the partner-down imediatelly. +partner - in partner-in-maintenance state - has taken over the DHCP traffic. +When the server in-maintenance state is shut down, the partner moves to +the partner-down state immediately. % HA_MAINTENANCE_STARTED the server is now in the partner-in-maintenance state and the partner is in-maintenance state This informational message is displayed when the server receiving the @@ -442,9 +442,9 @@ setup state warrants such behavior. % HA_STATE_MACHINE_PAUSED state machine paused in state %1 This informational message is issued when the HA state machine is paused. HA state machine may be paused in certain states specified in the HA hooks library -confuguration. When the state machine is paused, the server remains in the given -state until it is explicitly unpaused (via ha-continue command). If the state -machine is paused, the server operates normally but can't transition to any +configuration. When the state machine is paused, the server remains in the given +state until it is explicitly unpaused (via the ha-continue command). If the state +machine is paused, the server operates normally but cannot transition to any other state. % HA_STATE_TRANSITION server transitions from %1 to %2 state, partner state is %3 @@ -454,13 +454,13 @@ The arguments specify initial server state, new server state and the partner's state. % HA_STATE_TRANSITION_PASSIVE_BACKUP server transitions from %1 to %2 state -This informational message is issued when the server being in the passive-backup +This informational message is issued when the server in passive-backup mode transitions to a new state. The arguments specify initial server state and a new server state. % HA_SYNC_FAILED lease database synchronization with %1 failed: %2 This error message is issued to indicate that the lease database synchronization -failed. The first argument provides partner server's name. The second argument +failed. The first argument provides the partner server's name. The second argument provides a reason for the failure. % HA_SYNC_HANDLER_FAILED ha-sync command failed: %1 diff --git a/src/lib/dhcp_ddns/dhcp_ddns_messages.mes b/src/lib/dhcp_ddns/dhcp_ddns_messages.mes index d980200d97..4f05a66667 100644 --- a/src/lib/dhcp_ddns/dhcp_ddns_messages.mes +++ b/src/lib/dhcp_ddns/dhcp_ddns_messages.mes @@ -25,7 +25,7 @@ either case the error is unlikely to impair the application's ability to process requests but it should be reported for analysis. % DHCP_DDNS_NCR_RECV_NEXT_ERROR application could not initiate the next read following a request receive. -This is a error message indicating that NameChangeRequest listener could not +This is an error message indicating that NameChangeRequest listener could not start another read after receiving a request. While possible, this is highly unlikely and is probably a programmatic error. The application should recover on its own. @@ -38,7 +38,7 @@ case the error is unlikely to impair the client's ability to send requests but it should be reported for analysis. % DHCP_DDNS_NCR_SEND_NEXT_ERROR DHCP-DDNS client could not initiate the next request send following send completion: %1 -This is a error message indicating that NameChangeRequest sender could not +This is an error message indicating that NameChangeRequest sender could not start another send after completing the send of the previous request. While possible, this is highly unlikely and is probably a programmatic error. The application should recover on its own. diff --git a/src/lib/dhcpsrv/alloc_engine_messages.mes b/src/lib/dhcpsrv/alloc_engine_messages.mes index 0199af0f6f..595fe4b109 100644 --- a/src/lib/dhcpsrv/alloc_engine_messages.mes +++ b/src/lib/dhcpsrv/alloc_engine_messages.mes @@ -53,8 +53,8 @@ pool size and your classification definitions. % ALLOC_ENGINE_V4_DECLINED_RECOVERED IPv4 address %1 was recovered after %2 seconds of probation-period This informational message indicates that the specified address was reported as duplicate (client sent DECLINE) and the server marked this address as -unvailable for a period of time. This time now has elapsed and the address -has been returned to the available pool. This step concludes decline recovery +unavailable for a period of time. This time now has elapsed and the address +has been returned to the available pool. This step concludes the decline recovery process. % ALLOC_ENGINE_V4_DISCOVER_ADDRESS_CONFLICT %1: conflicting reservation for address %2 with existing lease %3 @@ -293,8 +293,8 @@ has now been allocated to another client. % ALLOC_ENGINE_V6_DECLINED_RECOVERED IPv6 address %1 was recovered after %2 seconds of probation-period This informational message indicates that the specified address was reported as duplicate (client sent DECLINE) and the server marked this address as -unvailable for a period of time. This time now has elapsed and the address -has been returned to the available pool. This step concludes decline recovery +unavailable for a period of time. This time now has elapsed and the address +has been returned to the available pool. This step concludes the decline recovery process. % ALLOC_ENGINE_V6_EXPIRED_HINT_RESERVED %1: expired lease for the client's hint %2 is reserved for another client diff --git a/src/lib/dhcpsrv/dhcpsrv_messages.mes b/src/lib/dhcpsrv/dhcpsrv_messages.mes index e3c903b93a..4448f67c87 100644 --- a/src/lib/dhcpsrv/dhcpsrv_messages.mes +++ b/src/lib/dhcpsrv/dhcpsrv_messages.mes @@ -54,33 +54,34 @@ there is a good reason for it, to avoid increased number of renewals and a need for rebinding (increase of multicast traffic, which may be received by multiple servers). -% DHCPSRV_CFGMGR_DDNS_PARAMETER_IGNORED dhpd-ddns:%1 is deprecated, using existing global:%2 +% DHCPSRV_CFGMGR_DDNS_PARAMETER_IGNORED dhcp-ddns:%1 is deprecated, using existing global:%2 This is an informational message issued during configuration parsing when the server detects that a deprecated parameter has been specified in the "dhcp-ddns" element which conflicts with its corresponding global parameter. When this occurs the server simply ignores the value from dhcp-ddns. The log message shows be the deprecated and the supported parameter names. -Note the configuration change only affects the in memory configuration. -You should modify your configuration to comply the supported parameters. +Note the configuration change only affects the in-memory configuration. +Modify the configuration to comply with the supported parameters. % DHCPSRV_CFGMGR_DDNS_PARAMETER_MOVED dhcp-ddns:%1 is deprecated, moving it to global:%2 This is an informational message issued during configuration parsing when the server detects that a deprecated parameter has been specified in the "dhcp-ddns" element for which no corresponding global value exists. When -this occurs the server removes the parameter from dhcp-ddns and inserts the -parameter into the global scope. The log message shows be the deprecated +this occurs, the server removes the parameter from dhcp-ddns and inserts the +parameter into the global scope. The log message shows the deprecated and the supported parameter names. Note the configuration change only affects -the in memory configuration. You should modify your configuration to comply +the in-memory configuration. Modify the configuration to comply with the supported parameters. % DHCPSRV_CFGMGR_DEL_SUBNET4 IPv4 subnet %1 removed This debug message is issued when a subnet is successfully removed from the -server configuration. The argument identifies the subnet removed. +server configuration. The argument identifies the removed subnet. % DHCPSRV_CFGMGR_DEL_SUBNET6 IPv6 subnet %1 removed This debug message is issued when a subnet is successfully removed from the +server configuration. The argument identifies the removed subnet. -% DHCPSRV_CFGMGR_IPV4_RESERVATIONS_NON_UNIQUE_IGNORED ignoring "ip-reservations-unique" setting because at least one of the host database backends does not support non unique IP reservations in a subnet +% DHCPSRV_CFGMGR_IPV4_RESERVATIONS_NON_UNIQUE_IGNORED ignoring "ip-reservations-unique" setting because at least one of the host database backends does not support non-unique IP reservations in a subnet This warning message is issued when the server failed to use the new setting of the ip-reservations-unique global parameter configured via the configuration backend. Some host database backends used apparently do not support specifying @@ -441,13 +442,13 @@ A debug message issued when a NameChangeRequest has been successfully sent to kea-dhcp-ddns. % DHCPSRV_DHCP_DDNS_SENDER_STARTED NameChangeRequest sender has been started: %1 -A informational message issued when a communications with kea-dhcp-ddns has +An informational message issued when a communication with kea-dhcp-ddns has been successfully started. % DHCPSRV_DHCP_DDNS_SENDER_STOPPED NameChangeRequest sender has been stopped. -A informational message issued when a communications with kea-dhcp-ddns has +An informational message issued when a communication with kea-dhcp-ddns has been stopped. This normally occurs during reconfiguration and as part of normal -shutdown. It may occur if kea-dhcp-ddns communications breakdown. +shutdown. It may occur if kea-dhcp-ddns communications break down. % DHCPSRV_DHCP_DDNS_SUSPEND_UPDATES DHCP_DDNS updates are being suspended. This is a warning message indicating the DHCP_DDNS updates have been turned @@ -678,29 +679,29 @@ replaced by those read from the file. A debug message issued when DHCP lease is being loaded from the file to memory. % DHCPSRV_MEMFILE_LEASE_LOAD_ROW_ERROR discarding row %1, error: %2 -An error message issued the the DHCP lease being loaded from the given row of +An error message issued if the DHCP lease being loaded from the given row of the lease file fails. The log message should contain the specific reason the -row was discarded. The server will continue loading the remaining data. +row was discarded. The server continues loading the remaining data. This may indicate a corrupt lease file. % DHCPSRV_MEMFILE_LFC_EXECUTE executing Lease File Cleanup using: %1 -An informational message issued when the Memfile lease database backend +An informational message issued when the memfile lease database backend starts a new process to perform Lease File Cleanup. % DHCPSRV_MEMFILE_LFC_LEASE_FILE_RENAME_FAIL failed to rename the current lease file %1 to %2, reason: %3 -An error message logged when the Memfile lease database backend fails to +An error message logged when the memfile lease database backend fails to move the current lease file to a new file on which the cleanup should be performed. This effectively means that the lease file cleanup -will not take place. +does not take place. -% DHCPSRV_MEMFILE_LFC_LEASE_FILE_REOPEN_FAIL failed to reopen lease file %1 after preparing input file for lease file cleanup, reason: %2, new leases will not be persisted! -An error message logged when the Memfile lease database backend +% DHCPSRV_MEMFILE_LFC_LEASE_FILE_REOPEN_FAIL failed to reopen lease file %1 after preparing input file for lease file cleanup, reason: %2, new leases will not persist! +An error message logged when the memfile lease database backend failed to re-open or re-create the lease file after renaming the -lease file for lease file cleanup. The server will continue to -operate but leases will not be persisted to disk. +lease file for lease file cleanup. The server continues to +operate but leases do not persist to disk. % DHCPSRV_MEMFILE_LFC_SETUP setting up the Lease File Cleanup interval to %1 sec -An informational message logged when the Memfile lease database backend +An informational message logged when the memfile lease database backend configures the LFC to be executed periodically. The argument holds the interval in seconds in which the LFC will be executed. diff --git a/src/lib/eval/eval_messages.mes b/src/lib/eval/eval_messages.mes index 6a9698ad67..7fc90c1dc6 100644 --- a/src/lib/eval/eval_messages.mes +++ b/src/lib/eval/eval_messages.mes @@ -110,7 +110,7 @@ The string is displayed in hex. % EVAL_DEBUG_RELAY6 Pushing PKT6 relay field %1 nest %2 with value %3 This debug message indicates that the given binary string representing -the value of the requested fied is being pushed onto the value stack. +the value of the requested field is being pushed onto the value stack. The string is displayed in hex. % EVAL_DEBUG_RELAY6_RANGE Pushing PKT6 relay field %1 nest %2 with value %3 diff --git a/src/lib/hooks/hooks_user.dox b/src/lib/hooks/hooks_user.dox index 55096ecf1a..66c2682bd8 100644 --- a/src/lib/hooks/hooks_user.dox +++ b/src/lib/hooks/hooks_user.dox @@ -1426,8 +1426,8 @@ logic. Consider the following example: ] @endcode -This example has three hook libraries configured. The first and and second have -no parameters. Note that parameters map is optional, but it's perfectly ok to +This example has three hook libraries configured. The first and second have +no parameters. Note that parameters map is optional, but it's perfectly okay to specify it as an empty map. The third library is more interesting. It has five parameters specified. The first one called 'mail' is a string. The second one is an integer and the third one is boolean. Fourth and fifth parameters are diff --git a/src/lib/http/http_messages.mes b/src/lib/http/http_messages.mes index a4a82d2444..87e7a69e4f 100644 --- a/src/lib/http/http_messages.mes +++ b/src/lib/http/http_messages.mes @@ -55,8 +55,8 @@ This debug message is issued when the server finished receiving a HTTP request from the remote endpoint. The address of the remote endpoint is specified as an argument. -% HTTP_CLIENT_REQUEST_RECEIVED_DETAILS detailed information about well formed request received from %1:\n%2 -This debug message is issued when the HTTP server receives a well formed +% HTTP_CLIENT_REQUEST_RECEIVED_DETAILS detailed information about well-formed request received from %1:\n%2 +This debug message is issued when the HTTP server receives a well-formed request. It includes detailed information about the received request. The first argument specifies an address of the remote endpoint which sent the request. The second argument provides the request in the textual format. @@ -121,8 +121,8 @@ seconds. This debug message is issued when the client finished receiving an HTTP response from the server. The URL of the server is specified as an argument. -% HTTP_SERVER_RESPONSE_RECEIVED_DETAILS detailed information about well formed response received from %1:\n%2 -This debug message is issued when the HTTP client receives a well formed +% HTTP_SERVER_RESPONSE_RECEIVED_DETAILS detailed information about well-formed response received from %1:\n%2 +This debug message is issued when the HTTP client receives a well-formed response from the server. It includes detailed information about the received response. The first argument specifies a URL of the server which sent the response. The second argument provides the response in the textual diff --git a/src/lib/log/log_messages.mes b/src/lib/log/log_messages.mes index bcb648c242..ee0b45f50f 100644 --- a/src/lib/log/log_messages.mes +++ b/src/lib/log/log_messages.mes @@ -84,9 +84,9 @@ not one contained in the compiled-in message dictionary. This message may appear a number of times in the file, once for every such unknown message identification. -There may be several reasons why this message may appear: +There are several reasons why this message may appear: -- The message ID has been mis-spelled in the local message file. +- The message ID has been misspelled in the local message file. - The program outputting the message may not use that particular message (e.g. it originates in a module not used by the program). diff --git a/src/lib/log/logging.dox b/src/lib/log/logging.dox index b0e990e7bc..86cf21dbfe 100644 --- a/src/lib/log/logging.dox +++ b/src/lib/log/logging.dox @@ -158,7 +158,7 @@ an executable or library) are:
  1. Create a message file. This defines messages by an identification -string and and text that explains the message in more detail. Ideally the +string and text that explains the message in more detail. Ideally the file should have a file type of ".mes".
  2. Run it through the message compiler to produce the files for your