diff mbox series

doc: Correct 'OnlineCheck{Initial,Max}Interval' units.

Message ID 20231222224711.2371812-1-gerickson@nuovations.com (mailing list archive)
State Not Applicable, archived
Headers show
Series doc: Correct 'OnlineCheck{Initial,Max}Interval' units. | expand

Commit Message

Grant Erickson Dec. 22, 2023, 10:47 p.m. UTC
This corrects the 'OnlineCheck{Initial,Max}Interval' units from 'secs'
to 'interval'.

Ultimately, in conjunction with a function associated with
'OnlineCheckIntervalStyle', 'OnlineCheck{Initial,Max}Interval' can be
translated into seconds; however, the values themselves are simply
unitless interval indices.
---
 doc/connman.conf.5.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Marcel Holtmann Dec. 23, 2023, 12:23 p.m. UTC | #1
Hi Grant,

> This corrects the 'OnlineCheck{Initial,Max}Interval' units from 'secs'
> to 'interval'.
> 
> Ultimately, in conjunction with a function associated with
> 'OnlineCheckIntervalStyle', 'OnlineCheck{Initial,Max}Interval' can be
> translated into seconds; however, the values themselves are simply
> unitless interval indices.
> ---
> doc/connman.conf.5.in | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)

patch has been applied.

Regards

Marcel
diff mbox series

Patch

diff --git a/doc/connman.conf.5.in b/doc/connman.conf.5.in
index 966c20709724..1f323980948c 100644
--- a/doc/connman.conf.5.in
+++ b/doc/connman.conf.5.in
@@ -225,7 +225,7 @@  default value is zero ('0') which indicates that no explicit
 connection timeout will be used, leaving the timeout to the underlying
 operating system and network stack.
 .TP
-.BI OnlineCheckInitialInterval= secs, OnlineCheckMaxInterval= secs
+.BI OnlineCheckInitialInterval= interval, OnlineCheckMaxInterval= interval
 Range of intervals between two online check requests.
 Please refer to the README for more detailed information.
 Default values are 1 and 12 respectively.