You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
See #331 for related issue/discussion.
Lacking documented approach for return code checking across functional tests.
Describe the solution you'd like
Update the error code list in API documentation to state: The specific error code definitions may be extended or refined in future versions of the software. Users should avoid unique error code handling except where required and documented explicitly in the API. Typical implementations should just check for OS_SUCCESS or report the error.
Typical return code documentation (for just execution status): \return Execution status. Success and error codes below are verified by test, but users should not assume the error code list is exhaustive. Precedence is not defined/enforced, calls with multiple errors may return any one of the related the error codes.
Scrub API error code documentation with the concept functional tests will verify the error codes explicitly defined, should just be a general set (not implementation unique).
Describe alternatives you've considered
See discussion in #331
Additional context
Coverage tests are expected to verify every implemented return code (white box). Functional tests are API based.
Requester Info
Jacob Hageman - NASA/GSFC
The text was updated successfully, but these errors were encountered:
Updates the documentation related to status code test/check, provide
description of how to check for any error status in a future-proof
manner.
Also updates the list of error code string conversions to match the
current set (some were missing).
Removes untraced capabilities to decompress libraries or
apps on load. For non-startup apps, FS can be used. For
startup, recommendation is to compress/decompress as part
of boot/startup vs individual applications/libs at load.
Also fixesnasa#291, by deprecating decompress it can be moved
to the FS app.
Also makes nasa#135 N/A, static code analysis issues in decompress
jphickey
pushed a commit
to jphickey/osal
that referenced
this issue
Aug 10, 2022
Is your feature request related to a problem? Please describe.
See #331 for related issue/discussion.
Lacking documented approach for return code checking across functional tests.
Describe the solution you'd like
The specific error code definitions may be extended or refined in future versions of the software. Users should avoid unique error code handling except where required and documented explicitly in the API. Typical implementations should just check for OS_SUCCESS or report the error.
\return Execution status. Success and error codes below are verified by test, but users should not assume the error code list is exhaustive. Precedence is not defined/enforced, calls with multiple errors may return any one of the related the error codes.
Describe alternatives you've considered
See discussion in #331
Additional context
Coverage tests are expected to verify every implemented return code (white box). Functional tests are API based.
Requester Info
Jacob Hageman - NASA/GSFC
The text was updated successfully, but these errors were encountered: