Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Fix #916, scrub include guards #931

Merged

Conversation

jphickey
Copy link
Contributor

Describe the contribution
Apply script to scrub all header file block comments and include guards on OSAL.

Fixes #916

Testing performed
Build and sanity check, run all unit tests

Expected behavior changes
None, comment and ifdef consistency fixups only

System(s) tested on
Ubuntu 20.04

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

Ensure all headers have a consistent include guard and file block comment
This gets all FSW code within src/os and src/bsp.
Ensure all headers have a consistent include guard and file block comment
This gets all unit tests (function, not coverage) and ut assert
@jphickey jphickey linked an issue Mar 25, 2021 that may be closed by this pull request
@jphickey
Copy link
Contributor Author

Pushed as draft to get started, this covers the actual FSW code in src/os and src/bsp as well as functional tests and ut assert.

I still need to run the script against the coverage stuff in src/unit-test-coverage (this alone has another 180+ headers in it) but the script wasn't working as well against those files (yet) so I didn't include them in the set for now.

Scrub all include guards and file scope doxygen comments in
src/unit-test-coverage
@jphickey jphickey marked this pull request as ready for review March 25, 2021 20:37
@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Mar 25, 2021
Filter out author and creation date info (not relevant)
@astrogeco
Copy link
Contributor

CCB:2021-03-31 APPROVED

  • Future work: replace \ with @ for doxygen commands

@astrogeco astrogeco added CCB:Approved Indicates code review and approval by community CCB IC:2021-04-06 and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Apr 8, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate April 8, 2021 02:24
@astrogeco astrogeco merged commit a876519 into nasa:integration-candidate Apr 8, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 8, 2021
nasa/osal#931 - Scrub include guards

nasa/osal#937 - Switch to use CLOCK_REALTIME

nasa/osal#938 - Specify shell name in ShellOutputToFile
astrogeco added a commit to nasa/cFS that referenced this pull request Apr 8, 2021
Combines:

nasa/cFE#1284
nasa/osal#951
nasa/PSP#289

Including:

nasa/cFE#1251 - ES Info API Functional test

nasa/osal#931 - Scrub include guards
nasa/osal#937 - Switch to use CLOCK_REALTIME
nasa/osal#938 - specify shell name in ShellOutputToFile

nasa/PSP#286 - use OSAL timebase for CFE timers
nasa/PSP#282 - modularize the ram, port, and eenasa/psp#om access
nasa/PSP#285 - add psp module to implement timebase
@jphickey jphickey deleted the fix-916-include-guards branch April 28, 2021 18:58
@skliper skliper added this to the 6.0.0 milestone Sep 24, 2021
# for free to join this conversation on GitHub. Already have an account? # 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.

Comments on header guard endif don't match ifdef
3 participants