Skip to content

Commit f9c6c48

Browse files
committed
doc: document job shell output.limit option
Problem: The job shell output.limit option is not documented. Document this option in flux-shell(1) as well the common job shell options table for the cli submission commands.
1 parent b4b32d3 commit f9c6c48

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

doc/man1/common/job-shell-options.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,8 @@
3939

4040
* - :option:`hwloc.xmlfile`
4141
- Write hwloc XML gathered by job to a file and set ``HWLOC_XMLFILE``
42+
43+
* - :option:`output.limit`
44+
- Set KVS output limit to SIZE bytes, where SIZE may be a floating point
45+
value including optional SI units: k, K, M, G. This value is ignored
46+
if output is directed to a file with :option:`--output`.

doc/man1/flux-shell.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,14 @@ plugins include:
318318
this option directly, as it will be set automatically by options
319319
of higher level commands such as :man1:`flux-submit`.
320320

321+
.. option:: output.limit=SIZE
322+
323+
Truncate KVS output after SIZE bytes have been written. SIZE may
324+
be a floating point value with optional SI units k, K, M, G. A value of
325+
0 is considered unlimited. The default KVS output limit is 10M for jobs
326+
in a multi-user instance or unlimited for single-user instance jobs.
327+
This value is ignored if output is directed to a file.
328+
321329
.. option:: output.{stdout,stderr}.path=PATH
322330

323331
Set job stderr/out file output to PATH.

0 commit comments

Comments
 (0)