LLDPD should document system refresh timer (tx-interval * 20)

In LLDPD, each port has its own timer to catch port-related
changes and is modified by changing the tx-interval.

LLDPD also starts another system based refresh timer on each port
for changes like hostname. This is the tx-interval multiplied by
20.  This needs to be documented.

Signed-off-by: Sam Tannous <stannous@cumulusnetworks.com>

diff --git a/src/client/lldpcli.8.in b/src/client/lldpcli.8.in
index 5a9012e1c9c7c04b1b7966c875f89c3efaca8475..f7def752c9f1b4bda24ca828c26814e6ec9d86a1 100644 (file)
--- a/src/client/lldpcli.8.in
+++ b/src/client/lldpcli.8.in
@@ -504,7 +504,11 @@ Force port description to the provided string.
 .Bd -ragged -offset XXXXXX
 Change transmit delay to the specified value in seconds. The transmit
 delay is the delay between two transmissions of LLDP PDU. The default
-value is 30 seconds.
+value is 30 seconds. Note:
+.Nm lldpd
+also starts another system based refresh timer on each port to detect
+changes such as a hostname. This is the value of the tx-interval
+multiplied by 20.
 .Ed
 
 .Cd configure