Skip to content

Commit 8e3c857

Browse files
committed
doc: document inactive_reason in flux-jobs(1)
Problem: The new inactive_reason field is not documented in flux-jobs(1). Add information about the new inactive_reason field.
1 parent 9d22430 commit 8e3c857

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/man1/flux-jobs.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,13 @@ the state of the job or other context:
453453
Returns the job runtime for jobs in RUN state or later, otherwise the
454454
job duration (if set) is returned.
455455

456+
**inactive_reason**
457+
If the job is inactive, returns the reason that the job is no
458+
longer active. Generally speaking, will output "Exit", "Timeout",
459+
"Canceled", or signal. If available, other contextual information
460+
will also be provided such as the exit ``returncode`` or
461+
cancellation message.
462+
456463
CONFIGURATION
457464
=============
458465

0 commit comments

Comments
 (0)