Skip to content

Commit 5670616

Browse files
committed
doc: clarify stats output in flux-jobs(1)
Problem: The flux-jobs(1) --stats and --stats-only output count all job failures ("failed", "timeout", "canceled") as a single statistic and output that as "failed". But this may not be obvious because job results are listed as completed, failed, timeout, and canceled. Add a clarification under the --stats and --stats-only descriptions.
1 parent 453ad33 commit 5670616

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/man1/flux-jobs.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ OPTIONS
104104
will display a summary of statistics along with the top 25
105105
running jobs, updated every 2 seconds.
106106

107+
Note that all job failures, including canceled and timeout jobs,
108+
are collectively counted as "failed" in ``--stats``.
109+
107110
**--stats-only**
108111
Output a summary of job statistics and exit. By default shows
109112
global statistics. If ``--queue`` is specified, shows statistics
@@ -116,6 +119,9 @@ OPTIONS
116119
All options other than ``--queue`` are ignored when
117120
``--stats-only`` is used.
118121

122+
Note that all job failures, including canceled and timeout jobs,
123+
are collectively counted as "failed" in ``--stats-only``.
124+
119125
**-R, --recursive**
120126
List jobs recursively. Each child job which is also an instance of
121127
Flux is prefixed by its jobid "path" followed by the list of jobs,

0 commit comments

Comments
 (0)