Skip to content

Commit

Permalink
doc: update description of epilog in flux-config-job-manager(5)
Browse files Browse the repository at this point in the history
Problem: The description of when the job epilog is run is not correct
in flux-config-job-manager(5).

Amend the description to include that the epilog runs after prolog
failure as well as on the finish event.
  • Loading branch information
grondo committed Sep 3, 2024
1 parent 5fd5bad commit 25942cb
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/man5/flux-config-job-manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -132,10 +132,11 @@ prolog
while the prolog is active terminates the prolog. The default is true.

epilog
(optional) Table of configuration for a job-manager epilog. If configured,
the epilog is started at the job ``finish`` event, i.e. after all user
processes and job shells have terminated. The ``[job-manager.epilog]``
table supports the following keys:
(optional) Table of configuration for a job-manager epilog. If
configured, the epilog is started at the job ``finish`` event,
i.e. after all user processes and job shells have terminated, or after
prolog failure (in which case there will not be a job ``finish`` event.)
The ``[job-manager.epilog]`` table supports the following keys:

command
(optional) An array of strings specifying the command to run. If
Expand Down

0 comments on commit 25942cb

Please sign in to comment.