Skip to content

Commit 3cd7b0f

Browse files
committed
doc: document size suffix for flux-restore --size-limit options
Problem: The use of [kKMG] in the SIZE argument of the flux-restore(1) --size-limit option is not documented. Amend the documentation of this option to describe the use of the optional suffixes.
1 parent bf1414c commit 3cd7b0f

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/man1/flux-restore.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,10 @@ OPTIONS
5454
store. Performance will vary depending on the content of the archive.
5555

5656
**--size-limit**\ =\ *SIZE*
57-
Skip restoring keys that exceed SIZE bytes (default: no limit).
57+
Skip restoring keys that exceed SIZE bytes (default: no limit). SIZE may
58+
be specified as a floating point number with an optional multiplicative
59+
suffix k or K=1024, M=1024\*1024, or G=1024\*1024\*1024 (up to
60+
``INT_MAX``).
5861

5962
RESOURCES
6063
=========

0 commit comments

Comments
 (0)