From db512f9c3080f730d8aa708a96ba44908706ffbf Mon Sep 17 00:00:00 2001 From: Albert Chu Date: Tue, 15 Aug 2023 14:22:52 -0700 Subject: [PATCH] doc: document flux resource watch Problem: The new flux resource watch subcommand is not documented. Add documentation in flux-resource.rst. --- doc/man1/flux-resource.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/man1/flux-resource.rst b/doc/man1/flux-resource.rst index bb3932ec3885..50763efed8a3 100644 --- a/doc/man1/flux-resource.rst +++ b/doc/man1/flux-resource.rst @@ -21,6 +21,8 @@ SYNOPSIS | **flux** **resource** **reload** [-f] [--xml] *path* +| **flux** **resource** **watch** [-a] [-r] + DESCRIPTION =========== @@ -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 =============