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 #1703, update docs for CFE_FS_BackgroundFileDumpRequest #1704

Merged

Conversation

jphickey
Copy link
Contributor

Describe the contribution
Update notes to better clarify that the meta object must persist for the duration of the dump operation, which occurs in another task, so it must not be on the stack.

Fixes #1703

Testing performed
Build and run all tests

Expected behavior changes
None - documentation only

System(s) tested on
Ubuntu

Additional context
Noted in PR #1650 which allocated meta object on stack during test (producing weird/unpredictable errors)

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

Update notes to better clarify that the meta object must persist
for the duration of the dump operation, which occurs in another task,
so it must not be on the stack.

Also update documentation for background even callbacks to better
clarify arguments and expectations of the implementation.
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Jul 28, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate July 29, 2021 03:00
@astrogeco astrogeco merged commit 0865774 into nasa:integration-candidate Jul 29, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jul 29, 2021
nasa/cFE#1704, update docs for CFE_FS_BackgroundFileDumpRequest
nasa/cFE#1706, correct return code mismatches
astrogeco added a commit to nasa/cFS that referenced this pull request Jul 29, 2021
Combines:

nasa/cFE#1701, v6.8.0-rc1+dev789
nasa/osal#1116, v5.1.0-rc1+dev578
nasa/cFS-GroundSystem#192, v2.2.0-rc1+dev58

Includes:

**cFE**

nasa/cFE#1699, correct return code check
nasa/cFE#1700, documentation for FS APIs that return OSAL codes
nasa/cFE#1695, Adding coverage tests for cfe_es_apps.c
nasa/cFE#1673, Add File Utility Functional Tests.
nasa/cFE#1711, Add custom epoch support to TIME UT
nasa/cFE#1720, Requirements update for Caelum
nasa/cFE#1721, Add null check to CFE_ES_TaskID_ToIndex.
nasa/cFE#1719, scrub command documentation
nasa/cFE#1715, Add time arithmetic functional tests
nasa/cFE#1704, update docs for CFE_FS_BackgroundFileDumpRequest
nasa/cFE#1706, correct return code mismatches

**osal**

nasa/osal#1114, Add unit test branch coverage

**cFS-GroundSystem**

nasa/cFS-GroundSystem#185, Update tlm for ES Blockstats/memstats and TBL HK
nasa/cFS-GroundSystem#188, * might be referenced before assignment

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: Jose F Martinez Pedraza <pepepr08@users.noreply.github.com>
Co-authored-by: Niall Mullane <nmullane@users.noreply.github.com>
Co-authored-by: Paul <pavll@users.noreply.github.com>
@jphickey jphickey deleted the fix-1703-bgfiledump-doc branch August 3, 2021 15:19
@astrogeco
Copy link
Contributor

CCB:2021-08-04 APPROVED

@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 Aug 25, 2021
@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.

Correct notes on CFE_FS_BackgroundFileDumpRequest
3 participants