mpi-forum / mpi-issues

Tickets for the MPI Forum
http://www.mpi-forum.org/
67 stars 8 forks source link

MPI_SUCCESS: Inconsistent use of \mpiconst and \const #756

Closed devreal closed 1 year ago

devreal commented 1 year ago

Problem

There are four instances in the document that use \mpiconst or \const for MPI_SUCCESS instead of the canonical \error macro:

 % grep const{MPI\\\\_SUCCESS chap* -r                
chap-coll/coll.tex:If the provided combination of \mpiarg{value\_type} and \mpiarg{index\_type} does not match a predefined pair datatype (named or unnamed), the function will set \mpiarg{pair\_type} to \mpiconst{MPI\_DATATYPE\_NULL} and return \mpiconst{MPI\_SUCCESS}.
chap-inquiry/inquiry.tex:0 = \const{MPI\_SUCCESS} < \constskip{MPI\_T\_ERR\_\XXX/} \leq \const{MPI\_ERR\_LASTCODE}.
chap-tools/mpit.tex:For the former case, the value \const{MPI\_SUCCESS} is returned.
chap-tools/mpit.tex:the routine.  Regardless of whether the return code is \const{MPI\_SUCCESS} or indicates that the procedure abnormally terminated, the \MPI/ process continues normal execution and does not invoke any \MPI/ error handler.   The \MPI/ implementation is

Proposal

Use \error for MPI_SUCCESS consistently throughout the document.

Changes to the Text

Minor formatting changes.

Impact on Implementations

None

Impact on Users

None

References and Pull Requests

TBD