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 #1396, scrub command documentation #1719

Merged

Conversation

jphickey
Copy link
Contributor

@jphickey jphickey commented Jul 28, 2021

Describe the contribution
Update documentation for all command codes in CFE core apps, in particular the error conditions, to confirm it matches the
actual implementation.

For common operations that apply to all commmands (length verification) this is now put into the users guide as a general statement rather than repeating the info in every command.

Fixes #1396
Fixes #1395

Testing performed
Build documentation and confirm output

Expected behavior changes
None (docs only)

System(s) tested on
Ubuntu

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

Update documentation for all command codes in CFE core apps, in
particular the error conditions, to confirm it matches the
actual implementation.

For common operations that apply to all commmands (length verification)
this is now put into the users guide as a general statement rather
than repeating the info in every command.
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Jul 28, 2021
@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 28, 2021
@astrogeco
Copy link
Contributor

CCB:2021-07-28 APPROVED

@astrogeco astrogeco changed the base branch from main to integration-candidate July 28, 2021 16:43
@astrogeco astrogeco merged commit 1b0e610 into nasa:integration-candidate Jul 28, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Jul 28, 2021
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
@skliper skliper added this to the 7.0.0 milestone Jul 28, 2021
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 <[email protected]>
Co-authored-by: Joseph Hickey <[email protected]>
Co-authored-by: Alex Campbell <[email protected]>
Co-authored-by: Jose F Martinez Pedraza <[email protected]>
Co-authored-by: Niall Mullane <[email protected]>
Co-authored-by: Paul <[email protected]>
@jphickey jphickey deleted the fix-1396-command-docs branch August 3, 2021 15:19
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.

Scrub error documentation section of command codes Scrub parameter documentation section of command codes
3 participants