Fix API presentations and return codes

Account for bad merges which missed them. Signed-off-by: dsolt@us.ibm.com
dsolt · Feb 7, 2022 · 4b9ce53 · 4b9ce53
1 parent b942e2d
commit 4b9ce53
Showing 1 changed file with 31 additions and 37 deletions.
diff --git a/Chap_API_Sync_Access.tex b/Chap_API_Sync_Access.tex
@@ -190,24 +190,24 @@ \subsection{\code{PMIx_Put}}
 %%%%
 \format
 
-\versionMarker{1.0}
-\cspecificstart
-\begin{codepar}
-pmix_status_t
-PMIx_Put(pmix_scope_t scope,
-         const pmix_key_t key,
-         pmix_value_t *val);
-\end{codepar}
-\cspecificend
+\copySignature{PMIx_Put}{1.0}{
+pmix_status_t \\
+PMIx_Put(pmix_scope_t scope, \\
+\hspace*{9\sigspace}const pmix_key_t key, \\
+\hspace*{9\sigspace}pmix_value_t *val);
+}
 
 \begin{arglist}
 \argin{scope}{Distribution scope of the provided value (handle)}
 \argin{key}{key (\refstruct{pmix_key_t})}
 \argin{value}{Reference to a \refstruct{pmix_value_t} structure (handle)}
 \end{arglist}
 
-Returns \refconst{PMIX_SUCCESS} or a negative value corresponding to a \ac{PMIx} error constant.
-If a reserved key is provided in the \refarg{key} argument then \refapi{PMIx_Put} will return \refconst{PMIX_ERR_BAD_PARAM}.
+\returnstart
+\begin{itemize}
+\item \refconst{PMIX_ERR_BAD_PARAM} indicating a reserved key is provided in the \refarg{key} argument.
+\end{itemize}
+\returnend
 
 %%%%
 \descr
@@ -272,24 +272,24 @@ \subsection{\code{PMIx_Store_internal}}
 %%%%
 \format
 
-\versionMarker{1.0}
-\cspecificstart
-\begin{codepar}
-pmix_status_t
-PMIx_Store_internal(const pmix_proc_t *proc,
-                    const pmix_key_t key,
-                    pmix_value_t *val);
-\end{codepar}
-\cspecificend
+\copySignature{PMIx_Store_internal}{1.0}{
+pmix_status_t \\
+PMIx_Store_internal(const pmix_proc_t *proc, \\
+\hspace*{20\sigspace}const pmix_key_t key, \\
+\hspace*{20\sigspace}pmix_value_t *val);
+}
 
 \begin{arglist}
 \argin{proc}{process reference (handle)}
 \argin{key}{key to retrieve (string)}
 \argin{val}{Value to store (handle)}
 \end{arglist}
 
-Returns \refconst{PMIX_SUCCESS} or a negative value corresponding to a PMIx error constant.
-If a reserved key is provided in the \refarg{key} argument then \refapi{PMIx_Store_internal} will return \refconst{PMIX_ERR_BAD_PARAM}.
+\returnstart
+\begin{itemize}
+\item \refconst{PMIX_ERR_BAD_PARAM} indicating a reserved key is provided in the \refarg{key} argument.
+\end{itemize}
+\returnend
 
 %%%%
 \descr
@@ -310,14 +310,11 @@ \subsection{\code{PMIx_Commit}}
 %%%%
 \format
 
-\versionMarker{1.0}
-\cspecificstart
-\begin{codepar}
+\copySignature{PMIx_Commit}{1.0}{
 pmix_status_t PMIx_Commit(void);
-\end{codepar}
-\cspecificend
+}
 
-Returns \refconst{PMIX_SUCCESS} or a negative value corresponding to a PMIx error constant.
+\returnsimple
 
 %%%%
 \descr
@@ -431,15 +428,12 @@ \section{\code{PMIx_Get}}
 %%%%
 \format
 
-\versionMarker{1.0}
-\cspecificstart
-\begin{codepar}
-pmix_status_t
-PMIx_Get(const pmix_proc_t *proc, const pmix_key_t key,
-         const pmix_info_t info[], size_t ninfo,
-         pmix_value_t **val);
-\end{codepar}
-\cspecificend
+\copySignature{PMIx_Get}{1.0}{
+pmix_status_t \\
+PMIx_Get(const pmix_proc_t *proc, const pmix_key_t key, \\
+\hspace*{9\sigspace}const pmix_info_t info[], size_t ninfo, \\
+\hspace*{9\sigspace}pmix_value_t **val);
+}
 
 \begin{arglist}
 \argin{proc}{Process identifier - a \code{NULL} value may be used in place of the caller's ID (handle)}