Skip to content

Commit 1fe5f5e

Browse files
committed
doc: add terms to glossary
Problem: some terminology related to parallel programs is missing from our glossary. Add the following to the glossary: - parallel program - clique - task - singleton Update other glossary definitons to link to these terms. Update some other man pages to link to thes terms.
1 parent 087cd3e commit 1fe5f5e

File tree

2 files changed

+27
-8
lines changed

2 files changed

+27
-8
lines changed

doc/guide/glossary.rst

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ used in our documentation that may not be familiar to all readers.
66

77
.. glossary::
88

9+
clique
10+
A group of :term:`tasks <task>` belonging to a :term:`parallel program`
11+
that are co-located on a node. Cliques may communicate with each other
12+
more efficiently than tasks on different nodes.
13+
914
enclosing instance
1015
The Flux instance that a process naturally interacts with. It is
1116
the instance referred to by the :envvar:`FLUX_URI` environment variable,
@@ -60,7 +65,9 @@ used in our documentation that may not be familiar to all readers.
6065

6166
job
6267
The smallest unit of work that can be allocated resources and run by Flux.
63-
A job can be a Flux instance which in turn can run more jobs.
68+
A job is typically a :term:`parallel program`, but may consist of one
69+
or more :term:`singletons <singleton>`. A job can be a Flux instance
70+
which in turn can run more jobs.
6471

6572
jobspec
6673
The JSON or YAML object representing a Flux job request, defined by
@@ -77,6 +84,10 @@ used in our documentation that may not be familiar to all readers.
7784
A moldable job requests a variable, bounded quantity of resources
7885
that, once allocated by the system, is fixed at runtime [#Feitelson96]_.
7986

87+
parallel program
88+
A ranked group of :term:`tasks`, often the same executable, launched
89+
in parallel and working together to solve a problem.
90+
8091
priority
8192
The order in which the scheduler considers jobs. By default, priority
8293
is derived from the :term:`urgency` and submit time, but a priority plugin
@@ -102,8 +113,11 @@ used in our documentation that may not be familiar to all readers.
102113
and resource utilization when it decides upon a schedule for fulfilling
103114
competing requests.
104115

116+
singleton
117+
A degenerate :term:`parallel program` with only one :term:`task`.
118+
105119
slot
106-
The abstract resource requirements of one task.
120+
The abstract resource requirements of one :term:`task`.
107121

108122
step
109123
In other workload managers, a job step is a unit of work within a job.
@@ -116,8 +130,12 @@ used in our documentation that may not be familiar to all readers.
116130
system user like ``flux``, is started by :linux:man1:`systemd`, and
117131
allows :term:`guest` users to run jobs.
118132

133+
task
134+
A process at the operating system level. A task may represent one
135+
rank of a :term:`parallel program`.
136+
119137
taskmap
120-
A compact mapping between job task ranks and node IDs, defined by
138+
A compact mapping between job :term:`task` ranks and node IDs, defined by
121139
:doc:`rfc:spec_34`.
122140

123141
TBON

doc/man1/flux-start.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -204,11 +204,12 @@ OPTIONS
204204

205205
.. option:: --test-pmi-clique=MODE
206206

207-
Set the pmi clique mode, which determines how ``PMI_process_mapping`` is set
208-
in the PMI server used to bootstrap the brokers. If ``none``, the mapping
209-
is not created. If ``single``, all brokers are placed in one clique. If
210-
``per-broker``, each broker is placed in its own clique. Otherwise the
211-
option argument is interpreted as an RFC 34 taskmap. Default: ``single``.
207+
Set the PMI :term:`clique` mode, which determines how
208+
``PMI_process_mapping`` is set in the PMI server used to bootstrap the
209+
brokers. If ``none``, the mapping is not created. If ``single``, all
210+
brokers are placed in one clique. If ``per-broker``, each broker is placed
211+
in its own clique. Otherwise the option argument is interpreted as an
212+
RFC 34 taskmap. Default: ``single``.
212213

213214
.. option:: -r, --recovery=[TARGET]
214215

0 commit comments

Comments
 (0)