Skip to content

Commit 14c2571

Browse files
committed
doc: update documentation of -q, --queue option where needed
Problem: Multiple queues may now be specified in the `-q, --queue` option of `flux-jobs(1)`, `flux-pgrep(1)`, and `flux-pkill(1)`, but this is not documented. Update the documentation of these commands.
1 parent 0497023 commit 14c2571

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

doc/man1/flux-jobs.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ OPTIONS
4646

4747
List jobs with a specific job name.
4848

49-
.. option:: -q, --queue=[QUEUE]
49+
.. option:: -q, --queue=QUEUE[,...]
5050

51-
List jobs in a specific queue.
51+
List jobs in a specific queue or queues. Multiple queues may be separated
52+
by a comma or by using the :option:`-q, --queue` option multiple times.
5253

5354
.. option:: -c, --count=N
5455

doc/man1/flux-pgrep.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,11 @@ OPTIONS
5656
results can be listed separated by comma. See the JOB STATUS section
5757
of the :man1:`flux-jobs` manual for more detail.
5858

59-
.. option:: -q, --queue=QUEUE
59+
.. option:: -q, --queue=QUEUE[,...]
6060

61-
Only include jobs in the named queue *QUEUE*.
61+
Only include jobs in the named queue *QUEUE*. Multiple queues may be
62+
specified as a comma-separated list, or by using the :option:`--queue`
63+
option multiple times.
6264

6365
.. option:: -c, --count=N
6466

0 commit comments

Comments
 (0)