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 #1337, add docs to CFE_ES_RegisterCDS() regarding clearing #1376

Merged

Conversation

jphickey
Copy link
Contributor

Describe the contribution
Note in the documentation for this function that it is the responsibility of the calling app to clear/fill the CDS block any time a new block is allocated.

Fixes #1337

Testing performed
Build and sanity check.

Expected behavior changes
None - Documentation only.

System(s) tested on
Ubuntu 20.04

Additional context
Don't recommend changing this behavior, it could easily break something or have unintended consequences, but should be clear in docs that a new CDS block must be written to before using, and it is the app/caller responsibility to do so.

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

Note in the documentation for this function that it is the responsibility
of the calling app to clear/fill the CDS block any time a new block is
allocated.
@skliper skliper added this to the 7.0.0 milestone Apr 19, 2021
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Apr 19, 2021
@astrogeco
Copy link
Contributor

CCB:2021-04-21 APPROVED

@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB IC:2021-04-20 and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Apr 21, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate April 22, 2021 01:30
@astrogeco astrogeco merged commit 3f9f7f5 into nasa:integration-candidate Apr 22, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 22, 2021
nasa/cFE#1290, Split interface and implementation modules

nasa/cFE#1376, add docs to CFE_ES_RegisterCDS() regarding clearing
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 22, 2021
Combines:

nasa/cFE#1406
nasa/osal#967
nasa/cFS-GroundSystem#178

Includes:

nasa/cFE#1290, Split interface and implementation modules
nasa/cFE#1376, add docs to CFE_ES_RegisterCDS() regarding clearing
nasa/cFE#1292, Remove testrunner and convert testcase to app
cfe-IC:2021-04-20, HOTFIX: Always build cfe_assert.

nasa/osal#950, Eliminate time and access name collisions with VxWorks
nasa/osal#946, Fix Shell implementation on posix and rtems

nasa/cFS-GroundSystem#174, update executable name and version in setup.py
nasa/cFS-GroundSystem#175, Add executable install guide
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 22, 2021
Combines:

nasa/cFE#1406
nasa/osal#967
nasa/cFS-GroundSystem#178

Includes:

nasa/cFE#1290, Split interface and implementation modules
nasa/cFE#1376, add docs to CFE_ES_RegisterCDS() regarding clearing
nasa/cFE#1292, Remove testrunner and convert testcase to app
cfe-IC:2021-04-20, HOTFIX: Always build cfe_assert.

nasa/osal#950, Eliminate time and access name collisions with VxWorks
nasa/osal#946, Fix Shell implementation on posix and rtems

nasa/cFS-GroundSystem#174, update executable name and version in setup.py
nasa/cFS-GroundSystem#175, Add executable install guide
zanzaben pushed a commit to zanzaben/cFE that referenced this pull request Apr 22, 2021
Fix nasa#1337, add docs to CFE_ES_RegisterCDS() regarding clearing
@jphickey jphickey deleted the fix-1337-cds-clear-doc branch May 14, 2021 14:23
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 CCB:FastTrack CFS-40
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CFE_ES_RegisterCDSEx: clear block if new allocation is needed but not new block size
3 participants