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 #1554, add doxygen aliases for OSAL parameter/retvals #1555

Merged
merged 1 commit into from
Jun 8, 2021

Conversation

jphickey
Copy link
Contributor

Describe the contribution

Adds "nonnull", "nonzero", and "covtest" tags to mark parameters and return values in documentation. This info is helpful when
auditing the test cases.

Fixes #1554

Testing performed
Build osalguide documentation, confirm output in the generated HTML

Expected behavior changes
Documentation only, no FSW.
Doxygen parameters and retvals can now be marked accordingly

System(s) tested on
Ubuntu

Additional context
This markup will be required for some of the OSAL return value verifications

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

Adds "nonnull", "nonzero", and "covtest" tags to mark parameters
and return values in documentation.  This info is helpful when
auditing the test cases.
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label May 20, 2021
@jphickey
Copy link
Contributor Author

If anyone has suggestions for a better tag name than "covtest" please suggest.

@jphickey jphickey added the docs This change only affects documentation. label May 20, 2021
@zanzaben
Copy link
Contributor

zanzaben commented May 20, 2021

If anyone has suggestions for a better tag name than "covtest" please suggest.

Something that relates to how those errors are produced by underlying system would be better. So for example: "underlying", "system", "external", "dependent" something along those lines.

@jphickey
Copy link
Contributor Author

actually no need to rush this one, see #1563 and nasa/osal#1033 instead which moves these templates/configs into OSAL, which is a preferable solution.

@jphickey
Copy link
Contributor Author

Withdrawing this one - nasa/osal#1033 combined with #1563 provides these, and is a better long-term solution.

@jphickey jphickey closed this May 26, 2021
@skliper skliper added wontfix and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels May 26, 2021
@jphickey jphickey reopened this Jun 3, 2021
@jphickey
Copy link
Contributor Author

jphickey commented Jun 3, 2021

This may be needed after all, since the CFE users guide also references the OSAL headers. So the extra nonnull/nonzero/covtest tags need to be also included in the CFE run to avoid warnings.

@jphickey jphickey removed the wontfix label Jun 3, 2021
@jphickey
Copy link
Contributor Author

jphickey commented Jun 3, 2021

Merged into integration-candidate in 51ecd53

astrogeco added a commit to nasa/cFS that referenced this pull request Jun 4, 2021
Combines:

nasa/osal#1058
nasa/cFE#1584
nasa/sch_lab#82

Includes:

nasa/sch_lab#81, exit the main loop if init fails
nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals
nasa/osal HOTFIX
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021
nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals
@astrogeco astrogeco merged commit 51ecd53 into nasa:main Jun 8, 2021
@jphickey jphickey deleted the fix-1554-doc-tags branch June 8, 2021 18:21
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021
- #263, bundle

Combines:

- nasa/cFE#1584, v6.8.0-rc1+dev642
- nasa/osal#1058, v5.1.0-rc1+dev500
- nasa/sch_lab#82, v2.4.0-rc1+dev36

Includes:

- nasa/cFE#1580, Update ES verify errors to match test
- nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt
- nasa/cFE#1579, Improve event filter documentation
- nasa/cFE#1576, EVS/FS documentation cleanup
- nasa/cFE#1575, Remove shell file subtype and clarify scope
- nasa/cFE#1582, Simplify file open/truncate logic
- nasa/cFE#1567, Remove deprecated elements
- nasa/cFE#1556, Replace Header Content Type magic number
- nasa/cFE#1553, Remove unused EVS LogMode defines
- nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS
- nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers
- nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type
- nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling
- nasa/cFE#1560, Documentation cleanup in TBL/TIME
- nasa/cFE#1558, Document TblName as app specific
- nasa/cFE#1563, use OSAL script to generate API guide
- nasa/cFE#1557, Include verify headers to validate config
- nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals

- nasa/osal#1033, include doxygen targets locally
- nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public
- nasa/osal#1040, resolve discrepancies between binsem API and unit tests
- nasa/osal#1029, add missing clock retcode tests
- nasa/osal#1046, resolve discrepancies between common API and unit tests
- nasa/osal#1041, resolve discrepancies between countsem API and unit tests
- nasa/osal#1045, resolve discrepancies between dir API and unit tests
- nasa/osal#1043, resolve discrepancies between module API and unit tests
- nasa/osal#1044, resolve discrepancies between mutex API and unit tests
- nasa/osal#1038, resolve discrepancies between queue API and unit tests
- nasa/osal#1037, resolve discrepancies between task API and unit tests
- nasa/osal#1051, resolve discrepancies between timebase API and unit tests
- nasa/osal#1030, check misc API return codes
- nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
- nasa/osal#1049, filter only whole words for keyword match
- nasa/osal#962, update OSAL Config Guide link

- nasa/sch_lab#81, exit the main loop if init fails

- HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build
workflow errors,
astrogeco added a commit to nasa/cFS that referenced this pull request Jun 8, 2021
- #263, bundle

Combines:

- nasa/cFE#1584, v6.8.0-rc1+dev642
- nasa/osal#1058, v5.1.0-rc1+dev500
- nasa/sch_lab#82, v2.4.0-rc1+dev36

Includes:

- nasa/cFE#1580, Update ES verify errors to match test
- nasa/cFE#1578, Resolve mismatched endforeach of CMakeList.txt
- nasa/cFE#1579, Improve event filter documentation
- nasa/cFE#1576, EVS/FS documentation cleanup
- nasa/cFE#1575, Remove shell file subtype and clarify scope
- nasa/cFE#1582, Simplify file open/truncate logic
- nasa/cFE#1567, Remove deprecated elements
- nasa/cFE#1556, Replace Header Content Type magic number
- nasa/cFE#1553, Remove unused EVS LogMode defines
- nasa/cFE#1570, Document cleanup from SB/MSG/SBR review, Remove unused CFE_SB_NO_SUBSCRIBERS
- nasa/cFE#1565, Add CFE_SB_DestinationD tag and use for pointers
- nasa/cFE#1564, Use CFE_MSG_SequenceCount_t for seqcnt type
- nasa/cFE#1562, Document CFE_ES_PoolCreateEx NumBlockSizes error handling
- nasa/cFE#1560, Documentation cleanup in TBL/TIME
- nasa/cFE#1558, Document TblName as app specific
- nasa/cFE#1563, use OSAL script to generate API guide
- nasa/cFE#1557, Include verify headers to validate config
- nasa/cFE#1555, add doxygen aliases for OSAL parameter/retvals

- nasa/osal#1033, include doxygen targets locally
- nasa/osal#1031, Document OS_ObjectIdToArrayIndex as public
- nasa/osal#1040, resolve discrepancies between binsem API and unit tests
- nasa/osal#1029, add missing clock retcode tests
- nasa/osal#1046, resolve discrepancies between common API and unit tests
- nasa/osal#1041, resolve discrepancies between countsem API and unit tests
- nasa/osal#1045, resolve discrepancies between dir API and unit tests
- nasa/osal#1043, resolve discrepancies between module API and unit tests
- nasa/osal#1044, resolve discrepancies between mutex API and unit tests
- nasa/osal#1038, resolve discrepancies between queue API and unit tests
- nasa/osal#1037, resolve discrepancies between task API and unit tests
- nasa/osal#1051, resolve discrepancies between timebase API and unit tests
- nasa/osal#1030, check misc API return codes
- nasa/osal#1039, Rename CodeQL cFE Build and add Duplicate Job
- nasa/osal#1049, filter only whole words for keyword match
- nasa/osal#962, update OSAL Config Guide link

- nasa/sch_lab#81, exit the main loop if init fails

- HOTFIX cFS-bundle, Use new osalguide logfile to fix documentation build
workflow errors,

Co-authored-by: Joseph Hickey <[email protected]>
Co-authored-by: Jake Hageman skliper <[email protected]>
Co-authored-by: Alex Campbell <[email protected]>
Co-authored-by: Ariel Adams <[email protected]>
Co-authored-by: Ross Peters <[email protected]>
@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
docs This change only affects documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation tag to indicate return vals that are not tested in functional test
4 participants