From a12e640da88f48f1708ef84d74a711b513349cb5 Mon Sep 17 00:00:00 2001 From: Joshua Hursey Date: Thu, 20 May 2021 10:57:08 -0500 Subject: [PATCH] Add provisional markers * Add `\versionMarkerProvisional` that marks the version level and adds the provisoinal designation. Signed-off-by: Joshua Hursey --- Chap_API_Data_Mgmt.tex | 8 ++++---- Chap_API_Struct.tex | 10 +++++----- pmix.sty | 3 +++ 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/Chap_API_Data_Mgmt.tex b/Chap_API_Data_Mgmt.tex index 45aaff0e..eb2dda17 100644 --- a/Chap_API_Data_Mgmt.tex +++ b/Chap_API_Data_Mgmt.tex @@ -396,7 +396,7 @@ \subsection{\code{PMIx_Data_load}} %%%% \format -\versionMarker{4.1} +\versionMarkerProvisional{4.1} \cspecificstart \begin{codepar} pmix_status_t @@ -447,7 +447,7 @@ \subsection{\code{PMIx_Data_unload}} %%%% \format -\versionMarker{4.1} +\versionMarkerProvisional{4.1} \cspecificstart \begin{codepar} pmix_status_t @@ -499,7 +499,7 @@ \subsection{\code{PMIx_Data_compress}} %%%% \format -\versionMarker{4.1} +\versionMarkerProvisional{4.1} \cspecificstart \begin{codepar} bool @@ -546,7 +546,7 @@ \subsection{\code{PMIx_Data_decompress}} %%%% \format -\versionMarker{4.1} +\versionMarkerProvisional{4.1} \cspecificstart \begin{codepar} bool diff --git a/Chap_API_Struct.tex b/Chap_API_Struct.tex index 2e7fbf04..b95ce2f5 100644 --- a/Chap_API_Struct.tex +++ b/Chap_API_Struct.tex @@ -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) @@ -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) @@ -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) @@ -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) @@ -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} diff --git a/pmix.sty b/pmix.sty index 4dfc30ef..eb011327 100644 --- a/pmix.sty +++ b/pmix.sty @@ -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