Merge pull request #489 from abouteiller/issue356/info_load_bool@v4

PMIX_Info_load BOOL with NULL sets value to true

Chap_API_Struct.tex

@@ -1384,7 +1384,6 @@ \subsubsection{Info structure support macros}
 \summary
 
 Load data into a \refstruct{pmix_info_t} structure.
-
 %%%%
 \format
 
@@ -1411,7 +1410,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}

Chap_Revisions.tex

@@ -1299,8 +1299,9 @@ \section{Version 4.2: TBD}
 
 \begin{compactitemize}
     \item Define when \refattr{PMIX_PARENT_ID} is set
-    \item Add adefinition for \refterm{tool}
+    \item Add a definition for \refterm{tool}
     \item Clarify \refattr{PMIX_CMD_LINE} in \refapi{PMIx_Spawn}
+    \item Add that using \refapi{PMIx_Info_load} with a \code{NULL} \refconst{PMIX_BOOL} data sets the value to true
 \end{compactitemize}
 
 \subsection{Deprecated constants}