Skip to content

Commit

Permalink
Merge pull request #6459 from grondo/resource-list-doc
Browse files Browse the repository at this point in the history
doc: improve `--include` documentation in flux-resource(1)
  • Loading branch information
mergify[bot] authored Nov 22, 2024
2 parents 607c57e + 640631e commit af5feae
Showing 1 changed file with 17 additions and 14 deletions.
31 changes: 17 additions & 14 deletions doc/man1/flux-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,9 @@ all
.. option:: -i, --include=TARGETS

Filter results to only include resources matching *TARGETS*, which may be
specified either as an idset of broker ranks or list of hosts in hostlist
form. It is not an error to specify ranks or hosts which do not exist.
specified either as an idset of broker ranks or list of hosts or nodes in
hostlist form. It is not an error to specify ranks, nodes, or hosts which
do not exist.

.. option:: -o, --format=FORMAT

Expand Down Expand Up @@ -138,8 +139,9 @@ example::
.. option:: -i, --include=TARGETS

Filter results to only include resources matching *TARGETS*, which may be
specified either as an idset of broker ranks or list of hosts in hostlist
form. It is not an error to specify ranks or hosts which do not exist.
specified either as an idset of broker ranks or list of hosts or nodes in
hostlist form. It is not an error to specify ranks, nodes, or hosts which
do not exist.

R
-
Expand All @@ -163,8 +165,9 @@ Emit an RFC 20 Resource Set based on the scheduler view of resources.
.. option:: -i, --include=TARGETS

Filter results to only include resources matching *TARGETS*, which may be
specified either as an idset of broker ranks or list of hosts in hostlist
form. It is not an error to specify ranks or hosts which do not exist.
specified either as an idset of broker ranks or list of hosts or nodes in
hostlist form. It is not an error to specify ranks, nodes, or hosts which
do not exist.

status
------
Expand Down Expand Up @@ -230,10 +233,10 @@ resources that share a state and online/offline state.

.. option:: -i, --include=TARGETS

Filter the results to only include resources matching *TARGETS*, which
may be specified either as an idset of broker ranks or list of hosts in
hostlist form. It is not an error to specify ranks or hosts which do not
exist.
Filter results to only include resources matching *TARGETS*, which may be
specified either as an idset of broker ranks or list of hosts or nodes in
hostlist form. It is not an error to specify ranks, nodes, or hosts which
do not exist.

.. option:: -o, --format=FORMAT

Expand Down Expand Up @@ -275,10 +278,10 @@ following options are available:

.. option:: -i, --include=TARGETS

Filter the results to only include resources matching *TARGETS*, which
may be specified either as an idset of broker ranks or list of hosts in
hostlist form. It is not an error to specify ranks or hosts which do not
exist.
Filter results to only include resources matching *TARGETS*, which may be
specified either as an idset of broker ranks or list of hosts or nodes in
hostlist form. It is not an error to specify ranks, nodes, or hosts which
do not exist.

If specified with *targets* (IDSET or HOSTLIST), drain the specified nodes.
Any remaining free arguments are recorded as a reason for the drain event.
Expand Down

0 comments on commit af5feae

Please sign in to comment.