Skip to content

Commit

Permalink
5.1 rev history: Mark when an item has been introduced first in 4.2 o…
Browse files Browse the repository at this point in the history
…r 5.0
  • Loading branch information
abouteiller committed Jan 17, 2025
1 parent ba5eca8 commit 36f6770
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions Chap_Revisions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1469,11 +1469,11 @@ \section{Version 4.2: May 2024}
\begin{compactitemize}
\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 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.
\item Clarify when \refattr{PMIX_PARENT_ID} attribute is provided (backport from v5.0).
\item Clarify the value of \refattr{PMIX_CMD_LINE} attribute in spawn case (backport from v5.0).
\item Add a definition for \refterm{tool}.
\item Add that using \refapi{PMIx_Info_load} with a \code{NULL} \refconst{PMIX_BOOL} data sets the value to true.
\end{compactitemize}

\subsection{Errata}
Expand All @@ -1483,7 +1483,7 @@ \subsection{Errata}
\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)}
\subsection{Added Functions (Provisional, backport from v5.0)}

\begin{compactitemize}
\item \refapi{PMIx_Data_embed}
Expand All @@ -1498,7 +1498,7 @@ \subsection{Added Functions (Provisional)}
\item \refapi{PMIx_Topology_destruct}
\end{compactitemize}

\subsection{Added Macros (Provisional)}
\subsection{Added Macros (Provisional, backport from v5.0)}

\begin{compactitemize}
\item \refmacro{PMIX_APP_STATIC_INIT}
Expand All @@ -1522,7 +1522,7 @@ \subsection{Added Macros (Provisional)}
\item \refmacro{PMIX_VALUE_STATIC_INIT}
\end{compactitemize}

\subsection{Added Constants (Provisional)}
\subsection{Added Constants (Provisional, backport from v5.0)}

\littleheader{Spawn constants}

Expand All @@ -1533,7 +1533,7 @@ \subsection{Added Constants (Provisional)}
\item \refconst{PMIX_ERR_JOB_WDIR_NOT_FOUND}
\end{compactitemize}

\subsection{Added Attributes (Provisional)}
\subsection{Added Attributes (Provisional, backport from v5.0)}

\littleheader{Spawn attributes}
\pasteAttributeItem{PMIX_ENVARS_HARVESTED}
Expand All @@ -1555,7 +1555,7 @@ \subsection{Added Attributes (Provisional)}

\subsection{Deprecated constants}

The following constants were deprecated in v4.2:
The following constants were deprecated in v4.2 (backport from v5.0):

\begin{constantdesc}
%
Expand All @@ -1566,7 +1566,7 @@ \subsection{Deprecated constants}

\subsection{Deprecated attributes}

The following attributes were deprecated in v4.2:
The following attributes were deprecated in v4.2 (backport from v5.0):

%
\declareAttributeDEP{PMIX_DEBUG_WAIT_FOR_NOTIFY}{"pmix.dbg.notify"}{bool}{
Expand All @@ -1575,7 +1575,7 @@ \subsection{Deprecated attributes}

\subsection{Deprecated macros}

The following macros were deprecated in v4.2:
The following macros were deprecated in v4.2 (backport from v5.0):

\begin{compactitemize}
\item \declaremacroDEP{PMIX_VALUE_LOAD} Replaced by the \refapi{PMIx_Value_load} \ac{API}
Expand All @@ -1602,8 +1602,8 @@ \section{Version 5.1: TBD}
The v5.1 update includes the following changes from the v5.0 document:

\begin{compactitemize}
\item Revision history now contains a list of errata changes.
\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 (first in v4.2).
\item Add that using \refapi{PMIx_Info_load} with a \code{NULL} \refconst{PMIX_BOOL} data sets the value to true (first in v4.2).
\item Clarified behavior differences between using \refconst{PMIX_RANK_WILDCARD} and listing all individual \refstruct{pmix_proc_t} in \refapi{PMIx_Connect}, \refapi{PMIx_Group_construct}, and \refapi{PMIx_Fence}.
\item Clarified that \refattr{PMIX_NODE_SIZE} counts processes that have not called PMIx.
\end{compactitemize}
Expand All @@ -1613,8 +1613,8 @@ \subsection{Errata}
The following errors were corrected in v5.1:

\begin{compactitemize}
\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}.
\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}.
\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} (first in v4.2).
\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} (first in v4.2).
\item String parameters that are not modified are now passed as \code{const} in \refapi{PMIx_Data_print}, \refapi{PMIx_Register_attributes}, \refapi{PMIx_server_delete_process_set}, \refapi{PMIx_Get_attribute_string}, and \refapi{PMIx_Get_attribute_name}.
\item Constants \refconst{PMIX_ERR_JOB_EXE_NOT_FOUND}, \refconst{PMIX_ERR_JOB_INSUFFICIENT_RESOURCES}, \refconst{PMIX_ERR_JOB_SYS_OP_FAILED}, and \refconst{PMIX_ERR_JOB_WDIR_NOT_FOUND} were missing a value.
\item Type definition for \refstruct{pmix_device_type_t} changed from \code{uint16_t} to \code{uint64_t}. It was already correct in the ABI.
Expand Down

0 comments on commit 36f6770

Please sign in to comment.