Skip to content

Commit

Permalink
Add provisional markers
Browse files Browse the repository at this point in the history
 * Add `\versionMarkerProvisional` that marks the version level and adds
   the provisoinal designation.
  • Loading branch information
jjhursey committed May 20, 2021
1 parent 96b9b6b commit b1f9b59
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
8 changes: 4 additions & 4 deletions Chap_API_Data_Mgmt.tex
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ \subsection{\code{PMIx_Data_load}}
%%%%
\format

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
pmix_status_t
Expand Down Expand Up @@ -447,7 +447,7 @@ \subsection{\code{PMIx_Data_unload}}
%%%%
\format

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
pmix_status_t
Expand Down Expand Up @@ -499,7 +499,7 @@ \subsection{\code{PMIx_Data_compress}}
%%%%
\format

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
bool
Expand Down Expand Up @@ -546,7 +546,7 @@ \subsection{\code{PMIx_Data_decompress}}
%%%%
\format

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
bool
Expand Down
10 changes: 5 additions & 5 deletions Chap_API_Struct.tex
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ \subsubsection{Namespace support macros}

Check if the provided \refstruct{pmix_nspace_t} is invalid.

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
PMIX_NSPACE_INVALID(a)
Expand Down Expand Up @@ -454,7 +454,7 @@ \subsubsection{Rank support macros}

Check if the given rank is a valid value

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
PMIX_RANK_IS_VALID(a)
Expand Down Expand Up @@ -600,7 +600,7 @@ \subsubsection{Process structure support macros}

Check for invalid namespace or rank value

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
PMIX_PROCID_INVALID(a)
Expand Down Expand Up @@ -633,7 +633,7 @@ \subsubsection{Process structure support macros}

Transfer contents of one \refstruct{pmix_proc_t} value to another \refstruct{pmix_proc_t}.

\versionMarker{4.1}
\versionMarkerProvisional{4.1}
\cspecificstart
\begin{codepar}
PMIX_PROCID_XFER(d, s)
Expand Down Expand Up @@ -2155,7 +2155,7 @@ \section{Generalized Data Types Used for Packing/Unpacking}
\declareconstitem{PMIX_COMPRESSED_STRING}
String compressed with zlib (\code{char*}).
%
\declareconstitemNEW{PMIX_COMPRESSED_BYTE_OBJECT}
\declareconstitemProvisional{PMIX_COMPRESSED_BYTE_OBJECT}
Byte object whose bytes have been compressed with zlib (\code{pmix_byte_object_t}).
%
\declareconstitem{PMIX_ALLOC_DIRECTIVE}
Expand Down
3 changes: 3 additions & 0 deletions pmix.sty
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,9 @@
\newcommand{\versionMarker}[1]{%
\textInMargin{\textit{PMIx v#1}}%
}
\newcommand{\versionMarkerProvisional}[1]{%
\textInMargin{\small{\hl{\textit{Provisional v#1}}}}%
}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% PMIx Standard Process markers
Expand Down

0 comments on commit b1f9b59

Please sign in to comment.