Skip to content

Commit

Permalink
flux-environment(7): add PMI client detail
Browse files Browse the repository at this point in the history
Problem: the description of libpmi and libpmi2 client methods
fails to mention that an optional PATH can be appended.

Add this detail.
  • Loading branch information
garlick committed Nov 11, 2023
1 parent 59e44a0 commit 6f802ff
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions doc/man7/flux-environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,13 @@ affect the broker's PMI client.
simple
Use the PMI-1 simple wire protocol.

libpmi2
:func:`dlopen` ``libpmi2.so`` and use the PMI-2 API.
libpmi2[:PATH]
:func:`dlopen` ``libpmi2.so`` and use the PMI-2 API, optionally at
a specific *PATH*.

libpmi
:func:`dlopen` ``libpmi.so`` and use the PMI-1 API.
libpmi[:PATH]
:func:`dlopen` ``libpmi.so`` and use the PMI-1 API, optionally at
a specific *PATH*.

single
Become a singleton. This always succeeds so should be the last method.
Expand Down

0 comments on commit 6f802ff

Please sign in to comment.