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

Editorial changes from proofread of v5.0 final document #447

Merged
merged 4 commits into from
May 5, 2023
Merged

Editorial changes from proofread of v5.0 final document #447

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
34971cc
Minor typos in terms
abouteiller Apr 14, 2023
e835cde
New functionalities will appear first in v5.0 before being backported to
abouteiller Apr 14, 2023
a458291
Reword advice constant integer values w.r.t. ABI
abouteiller Apr 14, 2023
513a173
Advise on KEYLEN and NSLEN should not contradict the ABI size of the
abouteiller Apr 14, 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
6 changes: 2 additions & 4 deletions Chap_API_Struct.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,8 @@ \subsection{PMIx Return Status Constants}
\adviceimplend

\adviceuserstart
Other than \refconst{PMIX_SUCCESS} (which is required to be zero), the integer value of any \ac{PMIx} error constant is left to the \ac{PMIx} library implementer with the constraint that it be negative and greater magnitude (i.e. of larger absolute value)
than
\refconst{PMIX_EXTERNAL_ERR_BASE}.
Thus, users are advised to always refer to constants by name, and not by a specific implementation's integer value, for portability between implementations and compatibility across library versions.
Other than \refconst{PMIX_SUCCESS} (which is required to be zero), the integer value of any \ac{PMIx} error constant are negative and of greater magnitude (i.e. of larger absolute value) than\refconst{PMIX_EXTERNAL_ERR_BASE}.
For compatibility with future versions, users are advised to always refer to constants by name, and not by their integer value which may be specific to an \ac{ABI} version.
raffenet marked this conversation as resolved.
Show resolved Hide resolved
\adviceuserend

The presentation of each \ac{API} in this document includes a list of return status constants which are either specific to that \ac{API} or are expected to be returned by the \ac{API} in normal use.
Expand Down