Skip to content

Commit

Permalink
errata: fix broken links in spec v2
Browse files Browse the repository at this point in the history
refs #378

Signed-off-by: Thomas Naughton <[email protected]>
  • Loading branch information
naughtont3 committed Jan 14, 2023
1 parent 79ed93a commit b06f18d
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions Chap_API_Key_Value_Mgmt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ \subsection{\code{PMIx_Get}}
The \refarg{info} array is used to pass user requests regarding the get operation.

\adviceuserstart
Information provided by the \ac{PMIx} server at time of process start is accessed by providing the namespace of the job with the rank set to \refconst{PMIX_RANK_WILDCARD}. The list of data referenced in this way is maintained on the \ac{PMIx} web site at \url{https://pmix.org/support/faq/wildcard-rank-access/} but includes items such as the number of processes in the namespace (\refattr{PMIX_JOB_SIZE}), total available slots in the allocation (\refattr{PMIX_UNIV_SIZE}), and the number of nodes in the allocation (\refattr{PMIX_NUM_NODES}).
Information provided by the \ac{PMIx} server at time of process start is accessed by providing the namespace of the job with the rank set to \refconst{PMIX_RANK_WILDCARD}. The list of data referenced in this way is maintained on the OpenPMIx web site at \url{https://openpmix.org/support/faq/rm-provided-information/} but includes items such as the number of processes in the namespace (\refattr{PMIX_JOB_SIZE}), total available slots in the allocation (\refattr{PMIX_UNIV_SIZE}), and the number of nodes in the allocation (\refattr{PMIX_NUM_NODES}).

Data posted by a process via \refapi{PMIx_Put} needs to be retrieved by specifying the rank of the posting process. All other information is retrievable using a rank of \refconst{PMIX_RANK_WILDCARD} when the information being retrieved refers to something non-rank specific (e.g., number of processes on a node, number of processes in a job), and using the rank of the relevant process when requesting information that is rank-specific (e.g., the \ac{URI} of the process, or the node upon which it is executing). Each subsection of Section \ref{api:struct:attributes} indicates the appropriate rank value for referencing the defined attribute.
\adviceuserend
Expand Down Expand Up @@ -219,7 +219,7 @@ \subsection{\code{PMIx_Get_nb}}
The \argref{info} array is used as described by the \refapi{PMIx_Get} routine.

\adviceuserstart
Information provided by the \ac{PMIx} server at time of process start is accessed by providing the namespace of the job with the rank set to \refconst{PMIX_RANK_WILDCARD}. The list of data referenced in this way is maintained on the \ac{PMIx} web site at \url{https://pmix.org/support/faq/wildcard-rank-access/} but includes items such as the number of processes in the namespace (\refattr{PMIX_JOB_SIZE}), total available slots in the allocation (\refattr{PMIX_UNIV_SIZE}), and the number of nodes in the allocation (\refattr{PMIX_NUM_NODES}).
Information provided by the \ac{PMIx} server at time of process start is accessed by providing the namespace of the job with the rank set to \refconst{PMIX_RANK_WILDCARD}. The list of data referenced in this way is maintained on the OpenPMIx web site at \url{https://openpmix.org/support/faq/rm-provided-information/} but includes items such as the number of processes in the namespace (\refattr{PMIX_JOB_SIZE}), total available slots in the allocation (\refattr{PMIX_UNIV_SIZE}), and the number of nodes in the allocation (\refattr{PMIX_NUM_NODES}).

In general, only data posted by a process via \refapi{PMIx_Put} needs to be retrieved by specifying the rank of the posting process. All other information is retrievable using a rank of \refconst{PMIX_RANK_WILDCARD}. See \ref{api:struct:attributes:retrieval} for an explanation regarding use of the \emph{level} attributes.
\adviceuserend
Expand Down
6 changes: 3 additions & 3 deletions Chap_Introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -186,14 +186,14 @@ \subsection{The \acf{PRI}}
\item Ease of adoption.\\
The \ac{PRI} is designed to be particularly easy for resource managers (and the \ac{SMS} in general) to adopt, thus facilitating a rapid uptake into that community for application portability.
Both client and server \ac{PMIx} libraries are included, along with examples of client usage and server-side integration.
A list of supported environments and versions is maintained on the \ac{PMIx} web site \url{https://pmix.org/support/faq/what-apis-are-supported-on-my-rm/}
A list of supported environments and versions is maintained on the OpenPMIx web site \url{https://openpmix.org}
\end{itemize}

The \ac{PRI} does provide some internal implementations that lie outside the scope of the \ac{PMIx} standard. This includes several convenience macros as well as support for consolidating collectives for optimization purposes (e.g., the \ac{PMIx} server aggregates all local \refapi{PMIx_Fence} calls before
passing them to the \ac{SMS} for global execution). In a few additional cases, the \ac{PMIx} community (in partnership with the \ac{SMS} subsystem providers) have determined that a base level of support for a given operation can best be portably provided by including it in the \ac{PRI}.

Instructions for downloading, and installing the \ac{PRI} are available
on the community's web site \url{https://pmix.org/code/getting-the-reference-implementation/}.The \ac{PRI} targets support for the Linux operating system.
on the OpenPMIx web site \url{https://openpmix.org}.The \ac{PRI} targets support for the Linux operating system.
A reasonable effort is made to support all major, modern Linux distributions; however, validation is limited to the most recent 2-3 releases of RedHat Enterprise Linux (RHEL), Fedora, CentOS, and SUSE Linux Enterprise Server (SLES).
In addition, development support is maintained for Mac OSX.
Production support for vendor-specific operating systems is included as provided by the vendor.
Expand All @@ -207,7 +207,7 @@ \subsection{The PMIx Reference RunTime Environment (PRRTE)}
provides an easy way of exploring \ac{PMIx} capabilities and testing PMIx-based
applications outside of a PMIx-enabled environment by providing a ``shim'' between the application and the host environment that includes full support for the \ac{PRI}. The intent of \ac{PRRTE} is not to replace any existing production environment, but rather to enable developers to work on systems that do not yet feature a PMIx-enabled host \ac{SMS} or one that lacks a \ac{PMIx} feature of interest. Instructions for downloading,
installing, and using \ac{PRRTE} are available
on the community's web site \url{https://pmix.org/code/getting-the-pmix-reference-server/}
on the OpenPMIx web site \url{https://openpmix.org}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Organization of this document}
Expand Down
8 changes: 4 additions & 4 deletions pmix-standard.bib
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ @inproceedings{2017-Castain-EuroMPI

@misc{event1,
Author = {R. H. Castain},
Howpublished = {\url{https://pmix.org/pmix-standard/event-notification/}},
Note = {[Online; accessed 03-Nov-2017]},
Howpublished = {\url{https://pmix.org/standard/RFC/event-notification/}},
Note = {[Online; accessed 13-Jan-2023]},
Title = {{RFC0002: PMIx Event Notification}},
Year = {2016}}

@misc{event2,
Author = {R. H. Castain},
Howpublished = {\url{https://pmix.org/pmix-standard/extend-event-notification/}},
Note = {[Online; accessed 03-Nov-2017]},
Howpublished = {\url{https://pmix.org/standard/RFC/extend-event-notification/}},
Note = {[Online; accessed 13-Jan-2023]},
Title = {{RFC0018: Extend the Event Notification RFC}},
Year = {2017}}

0 comments on commit b06f18d

Please sign in to comment.