Per WG, avoid use of term "slot"

Refer instead to "max procs that can be simultaneously executing"

Signed-off-by: Ralph Castain <[email protected]>

Author: rhc54

Chap_API_Reserved_Keys.tex

@@ -107,10 +107,10 @@ \subsection{Session realm attributes}
 }
 %
 \declareAttribute{PMIX_UNIV_SIZE}{"pmix.univ.size"}{uint32_t}{
-Number of allocated slots in a session - each slot may or may not be occupied
-by an executing process. Note that this attribute is equivalent to
-the \refattr{PMIX_MAX_PROCS} attributed combined with \refattr{PMIX_SESSION_INFO}
-array - it is included in the \ac{PMIx} Standard for historical reasons.
+Maximum number of process that can be simultaneously executing in 
+a session. Note that this attribute is equivalent to
+the \refattr{PMIX_MAX_PROCS} attribute for the \refterm{session} realm - it 
+is included in the \ac{PMIx} Standard for historical reasons.
 }
 %
 \declareAttribute{PMIX_TMPDIR}{"pmix.tmpdir"}{char*}{
@@ -120,6 +120,10 @@ \subsection{Session realm attributes}
 \declareAttribute{PMIX_TDIR_RMCLEAN}{"pmix.tdir.rmclean"}{bool}{
 Resource Manager will cleanup assigned temporary directory trees.
 }
+%
+\declareAttributeNEW{PMIX_HOSTNAME_KEEP_FQDN}{"pmix.fqdn"}{bool}{
+\acp{FQDN} are being retained by the \ac{PMIx} library.
+}
 
 \vspace{\baselineskip}
 
@@ -139,44 +143,44 @@ \subsection{Session realm attributes}
 The remaining session-related information can only be retrieved by including the \refattr{PMIX_SESSION_INFO} attribute in the \refarg{info} array passed to \refapi{PMIx_Get}:
 
 \declareAttribute{PMIX_ALLOCATED_NODELIST}{"pmix.alist"}{char*}{
-Comma-delimited list or regular expression of all nodes in the specified realm regardless of whether or not they currently host processes.
+Comma-delimited list or regular expression of all nodes in the specified realm regardless of whether or not they currently host processes. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttributeNEW{PMIX_NUM_ALLOCATED_NODES}{"pmix.num.anodes"}{uint32_t}{
-Number of nodes in the specified realm regardless of whether or not they currently host processes.
+Number of nodes in the specified realm regardless of whether or not they currently host processes. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttribute{PMIX_MAX_PROCS}{"pmix.max.size"}{uint32_t}{
 Maximum number of processes that can be executed in the specified realm.
 Typically, this is a constraint imposed by a scheduler or by user settings in a
-hostfile or other resource description.
+hostfile or other resource description. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttribute{PMIX_NODE_LIST}{"pmix.nlist"}{char*}{
-Comma-delimited list of nodes currently hosting processes in the specified realm.
+Comma-delimited list of nodes currently hosting processes in the specified realm. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttribute{PMIX_NUM_SLOTS}{"pmix.num.slots"}{uint32_t}{
-Number of slots allocated in the specified realm. Note that this attribute is
+Maximum number of processes that can simultaneously be executing in the specified realm. Note that this attribute is
 the equivalent to \refattr{PMIX_MAX_PROCS} -
-it is included in the \ac{PMIx} Standard for historical reasons.
+it is included in the \ac{PMIx} Standard for historical reasons. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttributeNEW{PMIX_NUM_NODES}{"pmix.num.nodes"}{uint32_t}{
-Number of nodes currently hosting processes in the specified realm.
+Number of nodes currently hosting processes in the specified realm. Defaults to the \refterm{job} realm.
 }
 
 %
 \declareAttribute{PMIX_NODE_MAP}{"pmix.nmap"}{char*}{
-Regular expression of nodes currently hosting processes in the specified realm - see \ref{cptr:api_server:noderegex} for an explanation of its generation.
+Regular expression of nodes currently hosting processes in the specified realm - see \ref{cptr:api_server:noderegex} for an explanation of its generation. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttribute{PMIX_PROC_MAP}{"pmix.pmap"}{char*}{
-Regular expression describing processes on each node in the specified realm - see \ref{cptr:api_server:ppnregex} for an explanation of its generation.
+Regular expression describing processes on each node in the specified realm - see \ref{cptr:api_server:ppnregex} for an explanation of its generation. Defaults to the \refterm{job} realm.
 }
 %
 \declareAttribute{PMIX_ANL_MAP}{"pmix.anlmap"}{char*}{
-Process mapping in Argonne National Laboratory's PMI-1/PMI-2 notation.
+Process map equivalent to \refattr{PMIX_PROC_MAP} expressed in Argonne National Laboratory's PMI-1/PMI-2 notation. Defaults to the \refterm{job} realm.
 }
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -198,7 +202,7 @@ \subsection{Job realm attributes}
 
 %
 \declareAttribute{PMIX_NSPACE}{"pmix.nspace"}{char*}{
-Namespace of the job - may be a numerical value expressed as a string, but is often an alphanumeric string carrying information solely of use to the system.
+Namespace of the job - may be a numerical value expressed as a string, but is often an alphanumeric string carrying information solely of use to the system. Required to be unique within the scope of the host environment.
 }
 %
 \declareAttribute{PMIX_JOBID}{"pmix.jobid"}{char*}{
@@ -209,14 +213,13 @@ \subsection{Job realm attributes}
 Starting global rank of the specified job.
 }
 %
-\pasteAttributeItemBegin{PMIX_MAX_PROCS}In this context, this is the maximum number of processes that can be executed in the specified job, which may be a subset of the number allocated to the overall session.
+\pasteAttributeItemBegin{PMIX_MAX_PROCS}In this context, this is the maximum number of processes that can be simultaneously executed in the specified job, which may be a subset of the number allocated to the overall session.
 \pasteAttributeItemEnd{}
 %
-\pasteAttributeItemBegin{PMIX_NUM_SLOTS}In this context, this is the number of
-slots assigned to the specified job, which may be a subset of the slots
+\pasteAttributeItemBegin{PMIX_NUM_SLOTS}In this context, this is the maximum number of
+process that can be simultaneously executing within the specified job, which may be a subset of the number
 allocated to the overall session. Jobs may reserve a subset of their assigned
-slots for dynamic operations such as \refapi{PMIx_Spawn} - i.e., not all slots
-may be occupied by executing processes from this job at a given point in time.
+maximum processes for dynamic operations such as \refapi{PMIx_Spawn}.
 \pasteAttributeItemEnd{}
 %
 \pasteAttributeItemBegin{PMIX_NUM_NODES}In this context, this is the number of
@@ -248,10 +251,6 @@ \subsection{Job realm attributes}
 Full path to the temporary directory assigned to the specified job, under \refattr{PMIX_TMPDIR}.
 }
 %
-\declareAttribute{PMIX_LOCALLDR}{"pmix.lldr"}{pmix_rank_t}{
-Lowest rank within the specified job on the node (defaults to current node in absence of \refattr{PMIX_HOSTNAME} or \refattr{PMIX_NODEID} qualifier).
-}
-%
 \declareAttribute{PMIX_JOB_SIZE}{"pmix.job.size"}{uint32_t}{
 Total number of processes in the specified job across all contained applications. Note that this value can be different from \refattr{PMIX_MAX_PROCS}. For example, users may choose to subdivide an allocation (running several jobs in parallel within it), and dynamic programming models may support adding and removing processes from a running \refterm{job} on-the-fly. In the latter case, \ac{PMIx} events may be used to notify processes within the job that the job size has changed.
 }
@@ -325,7 +324,6 @@ \subsection{Application realm attributes}
 Regular expression describing the result of the process mapping.
 }
 
-
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \subsection{Process realm attributes}
 \label{chap:res:prealm}
@@ -443,10 +441,6 @@ \subsection{Node realm keys}
 Comma-delimited list of names by which the target node is known.
 }
 %
-\declareAttributeNEW{PMIX_HOSTNAME_KEEP_FQDN}{"pmix.fqdn"}{bool}{
-\acp{FQDN} are being retained by the \ac{PMIx} library.
-}
-%
 \declareAttribute{PMIX_NODEID}{"pmix.nodeid"}{uint32_t}{
 Node identifier expressed as the node's index (beginning at zero) in an array of nodes within the active session. The value must be unique and directly correlate to the \refattr{PMIX_HOSTNAME} of the node - i.e., users can interchangeably reference the same location using either the \refattr{PMIX_HOSTNAME} or corresponding \refattr{PMIX_NODEID}.
 }
@@ -472,6 +466,10 @@ \subsection{Node realm keys}
 Array of \refstruct{pmix_proc_t} of all processes executing on the local node -- shortcut for \refapi{PMIx_Resolve_peers} for the local node and a \code{NULL} namespace argument. The process identifier is ignored for this attribute.
 }
 %
+\declareAttribute{PMIX_LOCALLDR}{"pmix.lldr"}{pmix_rank_t}{
+Lowest rank within the specified job on the node (defaults to current node in absence of \refattr{PMIX_HOSTNAME} or \refattr{PMIX_NODEID} qualifier).
+}
+%
 \declareAttribute{PMIX_LOCAL_CPUSETS}{"pmix.lcpus"}{pmix_data_array_t}{
 A \refstruct{pmix_data_array_t} array of string representations of the \ac{PU} binding bitmaps applied to each local \refterm{peer} on the caller's node upon launch. Each string shall begin with the name of the library that generated it (e.g., "hwloc") followed by a colon and the bitmap string itself. The array shall be in the same order as the processes returned by \refattr{PMIX_LOCAL_PEERS} for that namespace.
 }