Fix #1606, update documentation for CFE_ES_GetPoolBufInfo #1671
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
Corrects the return type documentation, on success this function returns the size of the buffer, it does not return CFE_SUCCESS. Additionally, this updates the general description of the pool implementation to reflect the variances in platform architectures (i.e. the buffer descriptor/overhead may be 12 bytes on a CPU with 32 bit size_t, but will be greater on a CPU with a 64 bit size_t).
jphickey
added
the
CCB:Ready
skliper
approved these changes
Jul 19, 2021
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
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 <[email protected]> Co-authored-by: Joseph Hickey <[email protected]> Co-authored-by: Alex Campbell <[email protected]> Co-authored-by: Oliver Hamburger <[email protected]>
astrogeco
added
CCB:Approved
|
CCB:2021-07-21 APPROVED |
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
Corrects the return type documentation, on success this function returns the size of the buffer, it does not return
CFE_SUCCESS.Additionally, this updates the general description of the pool implementation to reflect the variances in platform architectures
(i.e. the buffer descriptor/overhead may be 12 bytes on a CPU with 32 bit size_t, but will be greater on a CPU with a 64 bit
size_t).
Fixes #1606
Testing performed
Build documentation, check no new warnings (no code change)
Expected behavior changes
None
System(s) tested on
N/A
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.