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

Fix #1606, update documentation for CFE_ES_GetPoolBufInfo #1671

Merged
merged 1 commit into from
Jul 20, 2021

Conversation

jphickey
Copy link
Contributor

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.

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 jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Jul 16, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate July 20, 2021 22:51
@astrogeco astrogeco merged commit 162274b into nasa:integration-candidate Jul 20, 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 <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 astrogeco added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Jul 21, 2021
@astrogeco
Copy link
Contributor

CCB:2021-07-21 APPROVED

@jphickey jphickey deleted the fix-1606-mempool-doc branch August 3, 2021 15:19
@skliper skliper added this to the 7.0.0 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CFE_ES_GetPoolBufInfo Header has incorrect return description
3 participants