Skip to content

Commit 36dc5fc

Browse files
committed
doc: document enhanced size options in flux-filemap(1)
Problem: The use of an optional suffix in the argument to the flux-filemap(1) --chunksize and --small-file-threshold options is not documented. Enhance the documentation of these options to include use of the optional [kKMG] suffix.
1 parent 52af152 commit 36dc5fc

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/man1/flux-filemap.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,19 @@ OPTIONS
6868

6969
**--small-file-threshold=N**
7070
Set the threshold in bytes over which a regular file is mapped through
71-
the distributed content cache. Set to 0 to always use the content cache.
72-
The default is 4096 (*map* subcommand only).
71+
the distributed content cache. Set to 0 to always use the content cache.
72+
N may be specified as a floating point number with multiplicative suffix
73+
k,K=1024, M=1024\*1024, or G=1024\*1024\*1024 up to ``INT_MAX``.
74+
The default is 4K (*map* subcommand only).
7375

7476
**--disable-mmap**
7577
Never map a regular file through the distributed content cache.
7678

7779
**--chunksize=N**
7880
Limit the content mapped blob size to N bytes. Set to 0 for unlimited.
79-
The default is 1048576 (*map* subcommand only).
81+
N may be specified as a floating point number with multiplicative suffix
82+
k,K=1024, M=1024\*1024, or G=1024\*1024\*1024 up to ``INT_MAX``.
83+
The default is 1M (*map* subcommand only).
8084

8185
**--direct**
8286
Avoid indirection through the content cache when fetching the top level

0 commit comments

Comments
 (0)