Add revision history for v4.2

Signed-off-by: Aurélien Bouteiller <[email protected]>

Chap_Revisions.tex

@@ -1405,7 +1405,6 @@ \subsection{Deprecated constants}
 %
 \end{constantdesc}
 
-
 \subsection{Deprecated attributes}
 
 The following attributes were deprecated in v5.0:
@@ -1444,3 +1443,142 @@ \subsection{Removed Constants}
 Replaced by \refconst{PMIX_ERR_PARTIAL_SUCCESS}.
 \end{constantdesc}
 
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%% History: Version 4.2
+\section{Version 4.2: TBD}
+
+The v4.2 update came after v5.0 to backport select features to the v4 line.
+However, the v4.2 update succeeds v4.1; changes made in v5.0 do not apply to v4.2
+except if listed again in this changelog section.
+
+The v4.2 update includes the following changes from the v4.1 document:
+
+\begin{compactitemize}
+  \item Define when \refattr{PMIX_PARENT_ID} is set
+  \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
+  \item Revision history now contains a list of errata changes
+\end{compactitemize}
+
+\subsection{Errata}
+
+\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 payload argument in \refapi{pmix_iof_cbfunc_t} has been changed to a pointer to the type \refstruct{pmix_byte_object_t}.
+\end{compactitemize}
+
+\subsection{Added Functions (Provisional)}
+
+\begin{compactitemize}
+  \item \refapi{PMIx_Data_embed}
+  \item \refapi{PMIx_Value_load}
+  \item \refapi{PMIx_Value_unload}
+  \item \refapi{PMIx_Value_xfer}
+  \item \refapi{PMIx_Info_list_start}
+  \item \refapi{PMIx_Info_list_add}
+  \item \refapi{PMIx_Info_list_xfer}
+  \item \refapi{PMIx_Info_list_convert}
+  \item \refapi{PMIx_Info_list_release}
+  \item \refapi{PMIx_Topology_destruct}
+\end{compactitemize}
+
+\subsection{Added Macros (Provisional)}
+
+\begin{compactitemize}
+  \item \refmacro{PMIX_APP_STATIC_INIT}
+  \item \refmacro{PMIX_BYTE_OBJECT_STATIC_INIT}
+  \item \refmacro{PMIX_COORD_STATIC_INIT}
+  \item \refmacro{PMIX_CPUSET_STATIC_INIT}
+  \item \refmacro{PMIX_DATA_ARRAY_STATIC_INIT}
+  \item \refmacro{PMIX_DATA_BUFFER_STATIC_INIT}
+  \item \refmacro{PMIX_DEVICE_DIST_STATIC_INIT}
+  \item \refmacro{PMIX_ENDPOINT_STATIC_INIT}
+  \item \refmacro{PMIX_ENVAR_STATIC_INIT}
+  \item \refmacro{PMIX_FABRIC_STATIC_INIT}
+  \item \refmacro{PMIX_GEOMETRY_STATIC_INIT}
+  \item \refmacro{PMIX_INFO_STATIC_INIT}
+  \item \refmacro{PMIX_LOOKUP_STATIC_INIT}
+  \item \refmacro{PMIX_PROC_INFO_STATIC_INIT}
+  \item \refmacro{PMIX_PROC_STATIC_INIT}
+  \item \refmacro{PMIX_QUERY_STATIC_INIT}
+  \item \refmacro{PMIX_REGATTR_STATIC_INIT}
+  \item \refmacro{PMIX_TOPOLOGY_STATIC_INIT}
+  \item \refmacro{PMIX_VALUE_STATIC_INIT}
+\end{compactitemize}
+
+\subsection{Added Constants (Provisional)}
+
+\littleheader{Spawn constants}
+
+\begin{compactitemize}
+  \item \refconst{PMIX_ERR_JOB_EXE_NOT_FOUND}
+  \item \refconst{PMIX_ERR_JOB_INSUFFICIENT_RESOURCES}
+  \item \refconst{PMIX_ERR_JOB_SYS_OP_FAILED}
+  \item \refconst{PMIX_ERR_JOB_WDIR_NOT_FOUND}
+\end{compactitemize}
+
+\subsection{Added Attributes}
+
+\subsection{Added Attributes (Provisional)}
+
+\littleheader{Spawn attributes}
+\pasteAttributeItem{PMIX_ENVARS_HARVESTED}
+\pasteAttributeItem{PMIX_JOB_TIMEOUT}
+\pasteAttributeItem{PMIX_LOCAL_COLLECTIVE_STATUS}
+\pasteAttributeItem{PMIX_NODE_OVERSUBSCRIBED}
+\pasteAttributeItem{PMIX_SINGLETON}
+\pasteAttributeItem{PMIX_SPAWN_TIMEOUT}
+
+\littleheader{Tool attributes}
+\pasteAttributeItem{PMIX_IOF_FILE_PATTERN}
+\pasteAttributeItem{PMIX_IOF_FILE_ONLY}
+\pasteAttributeItem{PMIX_IOF_LOCAL_OUTPUT}
+\pasteAttributeItem{PMIX_IOF_MERGE_STDERR_STDOUT}
+\pasteAttributeItem{PMIX_IOF_RANK_OUTPUT}
+\pasteAttributeItem{PMIX_IOF_OUTPUT_RAW}
+\pasteAttributeItem{PMIX_IOF_OUTPUT_TO_DIRECTORY}
+\pasteAttributeItem{PMIX_IOF_OUTPUT_TO_FILE}
+
+\subsection{Deprecated constants}
+
+The following constants were deprecated in v4.2:
+
+\begin{constantdesc}
+%
+\declareconstitemDEP{PMIX_DEBUG_WAITING_FOR_NOTIFY}
+Renamed to \refconst{PMIX_READY_FOR_DEBUG}
+%
+\end{constantdesc}
+
+\subsection{Deprecated attributes}
+
+The following attributes were deprecated in v4.2:
+
+%
+\declareAttributeDEP{PMIX_DEBUG_WAIT_FOR_NOTIFY}{"pmix.dbg.notify"}{bool}{
+Renamed to \refattr{PMIX_DEBUG_STOP_IN_APP}
+}
+
+\subsection{Deprecated macros}
+
+The following macros were deprecated in v4.2:
+
+\begin{compactitemize}
+  \item \declaremacroDEP{PMIX_VALUE_LOAD} Replaced by the \refapi{PMIx_Value_load} \ac{API}
+  \item \declaremacroDEP{PMIX_VALUE_UNLOAD} Replaced by the \refapi{PMIx_Value_unload} \ac{API}
+  \item \declaremacroDEP{PMIX_VALUE_XFER} Replaced by the \refapi{PMIx_Value_xfer} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_LOAD} Replaced by the \refapi{PMIx_Info_load} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_XFER} Replaced by the \refapi{PMIx_Info_xfer} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_LIST_START} Replaced by the \refapi{PMIx_Info_list_start} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_LIST_ADD} Replaced by the \refapi{PMIx_Info_list_add} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_LIST_XFER} Replaced by the \refapi{PMIx_Info_list_xfer} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_LIST_CONVERT} Replaced by the \refapi{PMIx_Info_list_convert} \ac{API}
+  \item \declaremacroDEP{PMIX_INFO_LIST_RELEASE} Replaced by the \refapi{PMIx_Info_list_release} \ac{API}
+  \item \declaremacroDEP{PMIX_TOPOLOGY_DESTRUCT} Replaced by the \refapi{PMIx_Topology_destruct} \ac{API}
+  \item \declaremacroDEP{PMIX_TOPOLOGY_FREE} Not replaced.
+\end{compactitemize}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%