Skip to content

Commit d1d828d

Browse files
committed
doc: document optional suffix for --pad argument in flux-ping(1)
Problem: The flux-ping(1) --pad argument is now processed by optparse_get_size_int(), which means it may take a floating point argument with suffix in [kKMG], but this is not documented. Update the documentation of the flux-ping(1) --pad option.
1 parent b71a157 commit d1d828d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

doc/man1/flux-ping.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ OPTIONS
4040
respectively. Default: send to “*any*”.
4141

4242
**-p, --pad**\ *=N*
43-
Include in the payload a string of length *N* bytes. The payload will be
44-
echoed back in the response. This option can be used to explore the
45-
effect of message size on latency. Default: no padding.
43+
Include in the payload a string of length *N* bytes. *N* may be a
44+
floating point number with optional multiplicative suffix k,K=1024,
45+
M=1024\*1024, or G=1024\*1024\*1024. The payload will be echoed back in
46+
the response. This option can be used to explore the effect of message
47+
size on latency. Default: no padding.
4648

4749
**-i, --interval**\ *=N*
4850
Specify the delay, in seconds, between successive requests.

0 commit comments

Comments
 (0)