From 155e795225ca51152672300d9d8fd4b3d39f7bca Mon Sep 17 00:00:00 2001 From: Arnaud Quette Date: Tue, 26 Feb 2019 09:52:08 +0100 Subject: [PATCH] Fix typo and spelling Signed-off-by: Arnaud Quette --- docs/man/upscli_readline.txt | 4 ++-- docs/man/upscli_sendline.txt | 4 ++-- docs/man/upscmd.txt | 2 +- docs/man/upsrw.txt | 2 +- docs/nut-names.txt | 6 +++--- include/common.h | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/man/upscli_readline.txt b/docs/man/upscli_readline.txt index 2d96240614..06db9c62c3 100644 --- a/docs/man/upscli_readline.txt +++ b/docs/man/upscli_readline.txt @@ -25,9 +25,9 @@ ERR messages from linkman:upsd[8] are detected and will cause this function to return -1. The difference between the two functions is that *upscli_readline_timeout()* -let the caller decide the amount of time ('timeout' seconds) after which it +lets the caller decide the amount of time ('timeout' seconds) after which it should give up and return, whereas *upscli_readline()* does not offer this -freedom. +freedom, and uses NUT default network timeout (5 seconds). RETURN VALUE ------------ diff --git a/docs/man/upscli_sendline.txt b/docs/man/upscli_sendline.txt index e5ce332c25..cefa264538 100644 --- a/docs/man/upscli_sendline.txt +++ b/docs/man/upscli_sendline.txt @@ -26,9 +26,9 @@ The data in 'buf' must be a fully formatted protocol command as no parsing of the buffer occurs within this function. The difference between the two functions is that *upscli_sendline_timeout()* -let the caller decide the amount of time ('timeout' seconds) after which it +lets the caller decide the amount of time ('timeout' seconds) after which it should give up and return, whereas *upscli_sendline()* does not offer this -freedom. +freedom, and uses an immediate timeout (0 second). RETURN VALUE ------------ diff --git a/docs/man/upscmd.txt b/docs/man/upscmd.txt index b4278d0c28..a66d0f1399 100644 --- a/docs/man/upscmd.txt +++ b/docs/man/upscmd.txt @@ -51,7 +51,7 @@ The command will also block until an actual result is provided from the driver, or the timeout is reached (see *-t*). *-t* 'seconds':: -Set a timeout when using *-w*. Default to 10 seconds. +Set a timeout when using *-w*. Defaults to 10 seconds. 'ups':: Connect to this UPS. The format is `upsname[@hostname[:port]]`. The default diff --git a/docs/man/upsrw.txt b/docs/man/upsrw.txt index 8a183977eb..eb4ed351f8 100644 --- a/docs/man/upsrw.txt +++ b/docs/man/upsrw.txt @@ -67,7 +67,7 @@ The command will also block until an actual result is provided from the driver, or the timeout is reached (see *-t*). *-t* 'seconds':: -Set a timeout when using *-w*. Default to 10 seconds. +Set a timeout when using *-w*. Defaults to 10 seconds. 'ups':: View or change the settings on this UPS. The format for this option is diff --git a/docs/nut-names.txt b/docs/nut-names.txt index e7f4d86a1b..c5eb47cb3d 100644 --- a/docs/nut-names.txt +++ b/docs/nut-names.txt @@ -625,9 +625,9 @@ Instant commands | Name | Description | load.off | Turn off the load immediately | load.on | Turn on the load immediately -| load.off.delay | Turn off the load possibly after a delay -| load.on.delay | Turn on the load possibly after a delay -| shutdown.return | Turn off the load possibly after a delay +| load.off.delay | Turn off the load possibly after a delay +| load.on.delay | Turn on the load possibly after a delay +| shutdown.return | Turn off the load possibly after a delay and return when power is back | shutdown.stayoff | Turn off the load possibly after a delay and remain off even if power returns diff --git a/include/common.h b/include/common.h index 4f99e13ec5..248dadd374 100644 --- a/include/common.h +++ b/include/common.h @@ -53,7 +53,7 @@ extern "C" { extern const char *UPS_VERSION; -/** @brief Default timeout (in seconds) for network opereations, as used by `upsclient` and `nut-scanner`. */ +/** @brief Default timeout (in seconds) for network operations, as used by `upsclient` and `nut-scanner`. */ #define DEFAULT_NETWORK_TIMEOUT 5 /** @brief Default timeout (in seconds) for retrieving the result of a `TRACKING`-enabled operation (e.g. `INSTCMD`, `SET VAR`). */