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.

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

Error code documentation updates related to enforcement/test #399

Closed
skliper opened this issue Mar 30, 2020 · 1 comment · Fixed by #1072 or #1076
Closed

Error code documentation updates related to enforcement/test #399

skliper opened this issue Mar 30, 2020 · 1 comment · Fixed by #1072 or #1076

Comments

@skliper
Copy link
Contributor

skliper commented Mar 30, 2020

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

  1. 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.
  2. 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.
  3. 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

@skliper
Copy link
Contributor Author

skliper commented Mar 10, 2021

Also touched on in OSAL code review in relation to OS_HeapGetInfo

@skliper skliper added the CFS-38 label Mar 10, 2021
jphickey added a commit to jphickey/osal that referenced this issue Jun 9, 2021
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).
astrogeco added a commit that referenced this issue Jun 15, 2021
Fix #399, Update error codes and documentation
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
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 fixes nasa#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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants