Skip to content

Commit

Permalink
doc: add glossary references
Browse files Browse the repository at this point in the history
Problem: glossary terms are not referenced when used in
guide documents.

Reference them on first use in each document.
  • Loading branch information
garlick committed Oct 6, 2023
1 parent f54740d commit 8afc70f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions doc/guide/interact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@ socket and looks something like::

local:///tmp/flux-lMDa6Z/local-0

In the *initial program* (batch script, interactive alloc shell, or whatever),
the FLUX_URI environment variable is set to the local URI of the rank 0
broker. Flux commands in the initial program, which also runs on rank 0,
In the :term:`initial program` (batch script, interactive alloc shell, or
whatever), the FLUX_URI environment variable is set to the local URI of the rank
0 broker. Flux commands in the initial program, which also runs on rank 0,
read FLUX_URI and reference the instance that started them.

When running outside of an instance, FLUX_URI will not be set. In this case,
Expand Down
2 changes: 1 addition & 1 deletion doc/guide/start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ parallel, as a *parallel program* if you will.
phases:

#. Initialize
#. The rank 0 broker runs the **initial program** to completion
#. The rank 0 broker runs the :term:`initial program` to completion
#. Finalize

By default, the initial program is an interactive shell. If :man1:`flux-start`
Expand Down

0 comments on commit 8afc70f

Please sign in to comment.