Skip to content

Commit

Permalink
doc: document flux resource watch
Browse files Browse the repository at this point in the history
Problem: The new flux resource watch subcommand is not documented.

Add documentation in flux-resource.rst.
  • Loading branch information
chu11 committed Feb 2, 2024
1 parent ae08fc5 commit db512f9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/man1/flux-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ SYNOPSIS
| **flux** **resource** **reload** [-f] [--xml] *path*
| **flux** **resource** **watch** [-a] [-r]
DESCRIPTION
===========

Expand Down Expand Up @@ -291,6 +293,23 @@ This command is primarily used in test.

Do not fail if resource contain invalid ranks.

watch
-----

.. program:: flux resource watch

Output changes in resources from the *resource.eventlog* log as they
occur. May be useful when needing to see resource changes in real
time.

.. option:: -a, --all

Output all historical changes, not just new ones

.. option:: -r, --ranks

Output ranks instead of hosts


OUTPUT FORMAT
=============
Expand Down

0 comments on commit db512f9

Please sign in to comment.