Fix #1667, CFE_SB_MsgHdrSize returns size_t #1674
Merged
Conversation
This file contains 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
…urn CFE status code
astrogeco
added
the
CCB:Ready
zanzaben
approved these changes
Jul 19, 2021
jphickey
requested changes
Jul 19, 2021
There was a problem hiding this comment.
Just a minor recommendation - when documenting return values, the \returns tag should be just a generic description, and the \retval tag should be used for documenting specific values.
So, I'd recommend something like:
\returns Estimated number of bytes in the message header for the given message
\retval 0 if an error occurs, such as if the MsgPtr argument is not valid or header type cannot be identified
(Also to be pedantic, it is MsgPtr that is checked for NULL, not *MsgPtr)
jphickey
approved these changes
Jul 20, 2021
…urn CFE status code
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jul 20, 2021
nasa/cFE#1670, Update API doxygen list nasa/cFE#1671, update documentation for CFE_ES_GetPoolBufInfo nasa/cFE#1674, CFE_SB_MsgHdrSize returns size_t nasa/osal#1106, Add independent OS_rename functional test parameter checks
astrogeco
changed the title
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Jul 21, 2021
**Combines** nasa/cFE#1665, v6.8.0-rc1+dev762 nasa/osal#1113, v5.1.0-rc1+dev573 **Includes** nasa/cFE#1664, remove default .dat extension nasa/cFE#1660, Change CI to use Test Log. nasa/cFE#1670, Update API doxygen list nasa/cFE#1671, update documentation for CFE_ES_GetPoolBufInfo nasa/cFE#1674, CFE_SB_MsgHdrSize returns size_t nasa/cFE#1668, improve SB coverage test nasa/cFE#1694, correct function name in UT_BSP_Unlock nasa/osal#1106, Add independent OS_rename functional test parameter checks Co-authored-by: Jacob Hageman <skliper@users.noreply.github.com> Co-authored-by: Joseph Hickey <jphickey@users.noreply.github.com> Co-authored-by: Alex Campbell <zanzaben@users.noreply.github.com> Co-authored-by: Oliver Hamburger <oliverhamburger@users.noreply.github.com>
astrogeco
added
CCB:Approved
paulober
pushed a commit
to paulober/cFE
that referenced
this pull request
Aug 1, 2021
|
@oliverhamburger can you fill out a CLA? We are trying to submit an NTR for the Draco development cycle. |
CLA sent to GSFC-SoftwareRelease@mail.nasa.gov |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Fixes Issue #1667 by changing the return type in CFE_SB_MsgHdrSize and CFE_SB_GetUserDataLength
Testing performed
Build and ran unit tests
Expected behavior changes
CFE_SB_MsgHdrSize and CFE_SB_GetUserDataLength now return 0 when *MsgPtr is NULL
System(s) tested on
Ubuntu 20.04
Additional context
Add any other context about the contribution here.
Contributor Info
Oliver Hamburger GSFC