Skip to content

Commit

Permalink
doc: document shell.post-init in flux-shell(1)
Browse files Browse the repository at this point in the history
Problem: The new shell.post-init shell plugin callback topic is
not documented.

Add it to flux-shell(1).
  • Loading branch information
grondo committed Feb 5, 2024
1 parent 5958bc7 commit 73b47bb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/man1/flux-shell.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ execution of the job:
* change working directory to the cwd of the job
* enter a barrier to ensure shell initialization is complete on all shells
* emit ``shell.init`` event to exec.eventlog
* call ``shell.post-init`` plugin callbacks
* create all local tasks. For each task, the following procedure is used

- call ``task.init`` plugin callback
Expand Down Expand Up @@ -142,6 +143,10 @@ topics:
**jobspec** and **R** from the KVS, but before any tasks
are started.

**shell.post-init**
Called after the shell initialization barrier has completed, but
before starting any tasks.

**task.init**
Called for each task after the task info has been constructed
but before the task is executed.
Expand Down

0 comments on commit 73b47bb

Please sign in to comment.