Skip to content

Commit

Permalink
Better wording of advise on user defined event codes
Browse files Browse the repository at this point in the history
Co-authored-by: Aurelien Bouteiller <bouteill@icl.utk.edu>
  • Loading branch information
dsolt and abouteiller committed Sep 18, 2023
1 parent aa9793c commit 8262de4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion Chap_API_Event.tex
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ \subsection{\code{PMIx_Register_event_handler}}
Register an event handler to report events. Note that the codes being registered do \textit{not} need to be \ac{PMIx} event constants --- any integer value can be registered. This allows for registration of non-PMIx events such as those defined by a particular \ac{SMS} vendor or by an application itself.

\adviceuserstart
In order to avoid potential conflicts, users are advised to only use values as event codes if they lie outside the range of the \ac{PMIx} standard's error and event codes (See \ref{api:struct:usererrors}). Thus, \ac{SMS} vendors and application developers should constrain their definitions to positive values or negative values beyond the \refconst{PMIX_EXTERNAL_ERR_BASE} boundary.
In order to avoid potential conflicts, users are advised to only use event code values that lie outside the range of the \ac{PMIx} standard's error and event codes (See \ref{api:struct:usererrors}). Thus, \ac{SMS} vendors and application developers should constrain their definitions to positive values or negative values beyond the \refconst{PMIX_EXTERNAL_ERR_BASE} boundary.
\adviceuserend


Expand Down

0 comments on commit 8262de4

Please sign in to comment.