Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove 4.2 revision section. Move items to 5.0. #436

Merged
merged 3 commits into from
Feb 9, 2023
Merged

Remove 4.2 revision section. Move items to 5.0. #436

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63978b7
Remove 4.2 revision section. Move items to 5.0.
raffenet Jan 27, 2023
a43ad42
Update Chap_Revisions.tex
raffenet Feb 7, 2023
95f11a2
Update Chap_Revisions.tex
raffenet Feb 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 58 additions & 94 deletions Chap_Revisions.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1302,57 +1302,30 @@ \subsection{Added Attributes (Provisional)}
\pasteAttributeItem{PMIX_STORAGE_IOPS_CUR}
\pasteAttributeItem{PMIX_STORAGE_ACCESS_TYPE}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 4.2
\section{Version 4.2: TBD}

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 adefinition for \refterm{tool}
\item Clarify \refattr{PMIX_CMD_LINE} in \refapi{PMIx_Spawn}
\end{compactitemize}

\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}
%%%%%%%%%% History: Version 5.0
\section{Version 5.0: TBD}

The following macros were deprecated in v4.2:
The v5.0 update includes the following changes from the v4.1 document:

\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.
\item First release prepared using procedures defined in the PMIx
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
Exchange, Debugging, Hybrid Applications, MPI Sessions, and
Cross-Version Compatibility.
\item Add guidance on how PMIx defines an Application Binary Interface (ABI).
\item Add ABI query attributes.
\item Clarify three roles of consumers of the PMIx interface (client, server, tool).
\item Clarify when \refattr{PMIX_PARENT_ID} attribute is provided.
\item Clarify the value of \refattr{PMIX_CMD_LINE} attribute in spawn case.
\item Clarifications to Terms and Conventions chapter and addition of additional term definitions.
\item Re-organize the presentation of data access, synchronization, reserved keys and non-reserved keys.
\item Make presentation of return values consistent across APIs.
\item Attributes supported by PRRTE are no longer color coded. Refer to PRRTE documentation to see what is supported for a particular PRRTE version.
\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)}
Expand Down Expand Up @@ -1405,6 +1378,12 @@ \subsection{Added Constants (Provisional)}
\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}
Expand All @@ -1427,55 +1406,45 @@ \subsection{Added Attributes (Provisional)}
\pasteAttributeItem{PMIX_BREAKPOINT}
\pasteAttributeItem{PMIX_DEBUG_STOP_IN_APP}

\subsection{Deprecated constants}

The following constants were deprecated in v5.0:

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 5.0
\section{Version 5.0: TBD}

\begin{compactitemize}
\item First release prepared using procedures defined in the PMIx
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
Exchange, Debugging, Hybrid Applications, MPI Sessions, and
Cross-Version Compatibility.
\item Add guidance on how PMIx defines an Application Binary Interface (ABI).
\item Add ABI query attributes.
\item Clarify three roles of consumers of the PMIx interface (client, server, tool).
\item Clarify when \refattr{PMIX_PARENT_ID} attribute is provided.
\item Clarify the value of \refattr{PMIX_CMD_LINE} attribute in spawn case.
\item Clarifications to Terms and Conventions chapter and addition of additional term definitions.
\item Re-organize the presentation of data access, synchronization, reserved keys and non-reserved keys.
\item Make presentation of return values consistent across APIs.
\item Attributes supported by PRRTE are no longer color coded. Refer to PRRTE documentation to see what is supported for a particular PRRTE version.
\item NEW markers are removed from item declarations. Refer to \nameref{chap:revisions} to see when something was added.
\end{compactitemize}

%
%\subsection{Added \acp{API}}
\begin{constantdesc}
%
%\subsection{Added Constants}
\declareconstitemDEP{PMIX_DEBUG_WAITING_FOR_NOTIFY}
Renamed to \refconst{PMIX_READY_FOR_DEBUG}
%
\subsection{Added Attributes}
\end{constantdesc}

\littleheader{ABI attributes}
\pasteAttributeItem{PMIX_QUERY_STABLE_ABI_VERSION}
\pasteAttributeItem{PMIX_QUERY_PROVISIONAL_ABI_VERSION}

\subsection{Deprecated attributes}

The following attributes were deprecated in v5.0:

%
%\subsection{Added Macros}
%
%\subsection{Deprecated \acp{API}}
%
%\subsection{Deprecated Constants}
%
%\subsection{Deprecated Attributes}
%
%\subsection{Deprecated Macros}
%
%\subsection{Removed \acp{API}}
\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}

Expand All @@ -1487,9 +1456,4 @@ \subsection{Removed Constants}
Replaced by \refconst{PMIX_ERR_PARTIAL_SUCCESS}.
\end{constantdesc}

%\subsection{Removed Attributes}
%
%\subsection{Removed Macros}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%