diff --git a/Chap_Revisions.tex b/Chap_Revisions.tex index 91ed6d5..34cb288 100644 --- a/Chap_Revisions.tex +++ b/Chap_Revisions.tex @@ -1294,6 +1294,12 @@ \subsection{Added Attributes (Provisional)} %%%%%%%%%% History: Version 5.0 \section{Version 5.0: May 2023} +The v4.2 update released after v5.0 to backport select features to the v4 line. +The v4.2 update succeeds v4.1; changes made in v5.0 do not automatically apply +to v4.2, except if listed in the v4.2 changelog section. For this reason, this +changelog only includes a short summary of changes made during v5.0, please +refer to the v5.0 document for the complete v5.0 changelog. + The v5.0 update includes the following changes from the v4.1 document: \begin{compactitemize} @@ -1301,7 +1307,7 @@ \section{Version 5.0: May 2023} Governance v1.7 document\footnote{\url{https://github.com/pmix/governance/releases/tag/v1.7}}. \item Add specific values to constant definitions to ensure consistency across implementations. - \item Add \nameref{app:use-cases} appendix with descriptions for Business Card + \item Add use-cases appendix with descriptions for Business Card Exchange, Debugging, Hybrid Applications, MPI Sessions, and Cross-Version Compatibility. \item Add guidance on how PMIx defines an Application Binary Interface (ABI). @@ -1316,149 +1322,25 @@ \section{Version 5.0: May 2023} \item NEW markers are removed from item declarations. Refer to \nameref{chap:revisions} to see when something was added. \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} - -\littleheader{ABI attributes} -\pasteAttributeItem{PMIX_QUERY_STABLE_ABI_VERSION} -\pasteAttributeItem{PMIX_QUERY_PROVISIONAL_ABI_VERSION} - -\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} -\pasteAttributeItem{PMIX_BREAKPOINT} -\pasteAttributeItem{PMIX_DEBUG_STOP_IN_APP} - -\subsection{Deprecated constants} - -The following constants were deprecated in v5.0: - -\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 v5.0: - -% -\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 v5.0: - -\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} - -\subsection{Removed Constants} - -The following constants were removed: - -\begin{constantdesc} -\declareconstitemRM{PMIX_QUERY_PARTIAL_SUCCESS} -Some, but not all, of the requested information was returned. -Replaced by \refconst{PMIX_ERR_PARTIAL_SUCCESS}. -\end{constantdesc} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %%%%%%%%%% History: Version 4.2 -\section{Version 4.2: TBD} +\section{Version 4.2: May 2024} 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 +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 Release prepared using procedures defined in the PMIx + Governance v1.7 document\footnote{\url{https://github.com/pmix/governance/releases/tag/v1.7}}. + \item Revision history now contains a list of errata changes + \item Clarify when \refattr{PMIX_PARENT_ID} attribute is provided. + \item Clarify the value of \refattr{PMIX_CMD_LINE} attribute in spawn case. \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}