Skip to content

Commit

Permalink
Merge pull request #497 from abouteiller/issue356/info_load_bool@v5
Browse files Browse the repository at this point in the history
Issue356/info load bool@v5
  • Loading branch information
abouteiller authored Apr 12, 2024
2 parents 50bb0c7 + 80c6eb6 commit 8610519
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
8 changes: 7 additions & 1 deletion Chap_API_Struct.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1365,7 +1365,13 @@ \subsubsection{Info structure support macros}
%%%%
\descr

Copy the provided data into the \refstruct{pmix_info_t}. Any data stored in the source parameters can be modified or free'd without affecting the copied data once the function has completed.
Copy the provided data into the \refstruct{pmix_info_t}. Any data stored in the source parameters can be modified or free'd without affecting the copied data once the function has completed. Passing \code{NULL} as the \code{data} parameter with a \refconst{PMIX_BOOL} \code{type} will set the associated info to \code{true}. This is a shorthand for the following where \code{NULL} replaces an explicit variable \code{true_value}:
\begin{codepar}
// A PMIX_BOOL with a NULL data is equivalent to an explicit true data
bool true_value = true;
PMIX_Info_load(&info1, PMIX_SESSION_INFO, &true_value, PMIX_BOOL);
PMIX_Info_load(&info2, PMIX_SESSION_INFO, NULL, PMIX_BOOL);
\end{codepar}

%%%%%%%%%%%
\littleheader{Copy data between info structures}
Expand Down
5 changes: 3 additions & 2 deletions Chap_Revisions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1462,8 +1462,9 @@ \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 Add that using \refapi{PMIx_Info_load} with a \code{NULL} \refconst{PMIX_BOOL} data sets the value to true
\end{compactitemize}

\subsection{Added Functions (Provisional)}

Expand Down

0 comments on commit 8610519

Please sign in to comment.