gmegan / specification

OpenSHMEM Application Programming Interface
http://www.openshmem.org
1 stars 0 forks source link

Remove error code non-statement? #139

Open nspark opened 4 years ago

nspark commented 4 years ago

In a few teams interfaces, the 'Notes' section includes something like the following:

There are no specifically defined error codes for these routines. See Section 9 for expected error checking and return code behavior specific to implementations. For portable error checking and debugging behavior, programs should do their own checks for invalid team handles or SHMEM_TEAM_INVALID.

Is this statement of "we're not really specifying anything here" (w.r.t. error codes) necessary?

shamisp commented 4 years ago

It is essentially states that codes are undefined and implementation has to be sensible with what we do. I think it is useful ...

jdinan commented 4 years ago

Do we have somewhere in section 9 where we specify implementation-specific error codes? If we keep the statement, we should rewrite it to indicate (1) OpenSHMEM doesn't currently specify any particular error codes, (2) check the return value for success/failure where appropriate, and (3) also check the team handle that was returned.

jdinan commented 4 years ago

Resolved, see https://github.com/openshmem-org/specification/issues/292