Skip to content

Commit d16e5af

Browse files
committed
doc: document -B, --bank= option in flux submission commands
Problem: The `-B, --bank=` option is not documented. Add documentation of this option to job-param-additional.rst so it appears in the manual of the submission commands.
1 parent d9cd91e commit d16e5af

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/man1/common/job-param-additional.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@
66
option is ignored, though :man1:`flux-jobs` may display the queue
77
name in its rendering of the ``{queue}`` attribute.
88

9+
.. option:: -B, --bank=NAME
10+
11+
Set the bank name for this job to ``NAME``. This option is equivalent
12+
to `--setattr=bank=NAME`, and results in the ``bank`` attribute being
13+
set to ``NAME`` in the submitted jobspec. However, besides the bank
14+
name appearing in job listing output, this option may have no effect
15+
if no plugin or package that supports it (such as flux-accounting)
16+
is installed and configured.
17+
918
.. option:: -t, --time-limit=MINUTES|FSD
1019

1120
Set a time limit for the job in either minutes or Flux standard duration

0 commit comments

Comments
 (0)