Fix #963, improve documentation of UtAssert API calls#974
Merged
astrogeco merged 1 commit intonasa:integration-candidatefrom May 11, 2021
Merged
Fix #963, improve documentation of UtAssert API calls#974astrogeco merged 1 commit intonasa:integration-candidatefrom
astrogeco merged 1 commit intonasa:integration-candidatefrom
Conversation
The UtAssert API documentation was very terse and some references are obsolete/incorrect. This converts to doxygen form and corrects the stale/incorrect references. In particular - UtMemSet does not exist, but the standard C memset call should be used to fill a memory region with a constant value.
skliper
approved these changes
Apr 27, 2021
Contributor
|
Suggest adding in/out on params, but not critical. |
Contributor
Author
|
The branch was deleted by mistake, this is still needing merge |
jphickey
added
the
CCB:Ready
Contributor
|
CCB:2021-05-05 APPROVED |
astrogeco
added
the
CCB:Approved
astrogeco
added
IC:2021-05-11
and removed
CCB:Ready
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
May 11, 2021
nasa/osal#978, configuration guide updates nasa/osal#974, improve documentation of UtAssert API calls nasa/osal#977, update OS_TaskCreate doc
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
May 12, 2021
nasa/cFE#1492, cFE v6.8.0-rc1+dev575 nasa/osal#996, osal v5.1.0-rc1+dev434 nasa/cFE#1487, Remove broken travis-ci script nasa/cFE#1463, generated coverage stubs for CFE core nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API nasa/cFE#1451, OSAL config file simplification nasa/cFE#1489, removes --quiet option so files checked go to stdout nasa/osal#978, configuration guide updates nasa/osal#974, improve documentation of UtAssert API calls nasa/osal#977, update OS_TaskCreate doc nasa/osal#997, Enable cppcheck results output nasa/osal#980, Scrub return values nasa/osal#992, add local mutex to BSP console nasa/osal#993, do not require nonblock mode
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
May 12, 2021
nasa/cFE#1492, cFE v6.8.0-rc1+dev575 nasa/osal#996, osal v5.1.0-rc1+dev434 nasa/cFE#1487, Remove broken travis-ci script nasa/cFE#1463, generated coverage stubs for CFE core nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API nasa/cFE#1451, OSAL config file simplification nasa/cFE#1489, removes --quiet option so files checked go to stdout nasa/osal#978, configuration guide updates nasa/osal#974, improve documentation of UtAssert API calls nasa/osal#977, update OS_TaskCreate doc nasa/osal#997, Enable cppcheck results output nasa/osal#980, Scrub return values nasa/osal#992, add local mutex to BSP console nasa/osal#993, do not require nonblock mode Co-authored-by: Jacob Hageman <[email protected]> Co-authored-by: Joseph Hickey <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe the contribution
The UtAssert API documentation was very terse and some references are obsolete/incorrect. This converts to doxygen form and
corrects the stale/incorrect references.
In particular - UtMemSet does not exist, but the standard C memset call should be used to fill a memory region with a constant value.
Fixes #963
Testing performed
Build and sanity check CFE, run all tests
Expected behavior changes
None - documentation only
System(s) tested on
Ubuntu 20.04
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.