From 58ff0c8870e680b3d71ed305a1e9c040e72fb2eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Bouteiller?= Date: Wed, 7 Jun 2023 15:21:01 -0400 Subject: [PATCH 1/2] Change type of key parameter to PMIx_Get_nb to match PMIx_get (i.e., pmix_key_t) (cherry picked from commit 7bbae9e98421094aac726a45cb2c31a1eb6f4cdd) Add the inclusion of an errata list to the revision history (cherry picked from commit f6dc2addd898870d6b384f47a52c6dedf88602de) --- Chap_API_Sharing_Basics.tex | 2 +- Chap_Revisions.tex | 13 +++++++++++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/Chap_API_Sharing_Basics.tex b/Chap_API_Sharing_Basics.tex index d58980e..6fda602 100644 --- a/Chap_API_Sharing_Basics.tex +++ b/Chap_API_Sharing_Basics.tex @@ -506,7 +506,7 @@ \subsection{\code{PMIx_Get_nb}} \cspecificstart \begin{codepar} pmix_status_t -PMIx_Get_nb(const pmix_proc_t *proc, const char key[], +PMIx_Get_nb(const pmix_proc_t *proc, const pmix_key_t key, const pmix_info_t info[], size_t ninfo, pmix_value_cbfunc_t cbfunc, void *cbdata); \end{codepar} diff --git a/Chap_Revisions.tex b/Chap_Revisions.tex index ee6cadc..cbebcfa 100644 --- a/Chap_Revisions.tex +++ b/Chap_Revisions.tex @@ -1462,8 +1462,17 @@ \section{Version 5.1: TBD} The v5.1 update includes the following changes from the v5.0 document: -%\begin{compactitemize} -%\end{compactitemize} +\begin{compactitemize} + \item Revision history now contains a list of errata changes +\end{compactitemize} + +\subsection{Errata} + +The following errors were corrected in v5.1: + +\begin{compactitemize} + \item Parameter type for the key argument in \refapi{PMIx_Get_nb} has been changed to the equivalent type \refstruct{pmix_key_t} so that it is uniform with the argument in \refapi{PMIx_Get}. +\end{compactitemize} \subsection{Added Functions (Provisional)} From 1a38e2354e56dfaf6c93abd7f20e4afb062f6fe7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Bouteiller?= Date: Mon, 29 Apr 2024 16:43:18 -0400 Subject: [PATCH 2/2] Correct fix for #420: get key_t param -> char [] (cherry picked from commit 491c31f0ea781bc630c008677b5dd623d3f23cc0) --- Chap_API_Sharing_Basics.tex | 6 +++--- Chap_Revisions.tex | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Chap_API_Sharing_Basics.tex b/Chap_API_Sharing_Basics.tex index 6fda602..a359ab2 100644 --- a/Chap_API_Sharing_Basics.tex +++ b/Chap_API_Sharing_Basics.tex @@ -429,14 +429,14 @@ \section{\code{PMIx_Get}} \copySignature{PMIx_Get}{1.0}{ pmix_status_t \\ -PMIx_Get(const pmix_proc_t *proc, const pmix_key_t key, \\ +PMIx_Get(const pmix_proc_t *proc, const char 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)} -\argin{key}{Key to retrieve (\refstruct{pmix_key_t})} +\argin{key}{Key to retrieve (string)} \argin{info}{Array of info structures (array of handles)} \argin{ninfo}{Number of elements in the \refarg{info} array (integer)} \argout{val}{value (handle)} @@ -506,7 +506,7 @@ \subsection{\code{PMIx_Get_nb}} \cspecificstart \begin{codepar} pmix_status_t -PMIx_Get_nb(const pmix_proc_t *proc, const pmix_key_t key, +PMIx_Get_nb(const pmix_proc_t *proc, const char key[], const pmix_info_t info[], size_t ninfo, pmix_value_cbfunc_t cbfunc, void *cbdata); \end{codepar} diff --git a/Chap_Revisions.tex b/Chap_Revisions.tex index abcc83a..3b63771 100644 --- a/Chap_Revisions.tex +++ b/Chap_Revisions.tex @@ -1472,7 +1472,7 @@ \subsection{Errata} The following errors were corrected in v5.1: \begin{compactitemize} - \item Parameter type for the key argument in \refapi{PMIx_Get_nb} has been changed to the equivalent type \refstruct{pmix_key_t} so that it is uniform with the argument in \refapi{PMIx_Get}. + \item Parameter type for the key argument in \refapi{PMIx_Get} has been changed from \refstruct{pmix_key_t} to \code{char []} so that it is uniform with the argument in \refapi{PMIx_Get_nb}. \end{compactitemize} \subsection{Added Functions (Provisional)}