Fix #1239, scrub include header guards #1262
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
All C header files should have a header guard matching the file name of the header, in ALL_CAPS, with no extra leading/trailing underscores. This also takes a first pass at converting the file-scope block comments to a doxygen format to include a summary of the file.
jphickey
added
the
CCB:Ready
skliper
reviewed
Mar 24, 2021
This removes cases where extra blank lines in comments were present. This affects both the newly added blocks as well as some existing cases where extra blank lines were inside block comments.
astrogeco
removed
the
CCB:Ready
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Mar 29, 2021
nasa/osal#923 - Fix #831, Finish os-impl-bsd-socket.c coverage testing nasa/cFE#1237 - Fix #1180, Removes impossible conditions nasa/cFE#1240 - Fix #1002, Remove deprecated elements nasa/cFE#1253 - Fix #1252, Squash potentially uninitialized variable warnings nasa/cFE#1241 - Fix #1185, Squash possible uninitialized variable false alarms nasa/cFE#1247 - Fix #1246, Typo in CFE_TBL_Validate AppName nasa/cFE#1234 - Fix #1192, Initialize TotalMsgSize in CFE_SB_GetUserDataLength nasa/cFE#1245 - Fix #1187, Increment CreatePipeErrorCounter for all create pipe errors nasa/cFE#1236 - Fix #1186, Remove useless assignments/checks nasa/cFE#1262 - Fix #1239, scrub include header guards nasa/cFE#1256 - Fix #1194, check for NULL in SlotUsed helpers nasa/cFE#1263 - Fix #1261, removed redundant checks for CFE_SUCCESS nasa/cFE#1250 - Fix #1215, remove task registration calls nasa/cFE#1242 - Fix #1223, shorten TestRunner function name nasa/cFE#1242 - Fix #1264, Convert functional test startup script example to use "simple" filenames nasa/cFE#1229 - Fix #1164, use FS file name parser for commands nasa/cFE#1257 - Fix #1155, clean up zero copy API nasa/cFE#1254 - Fix #1181, global variable cleanup nasa/cFE#1255 - Fix #1206, report PSP version in ES HK TLM
astrogeco
added a commit
to nasa/cFS
that referenced
this pull request
Apr 1, 2021
nasa/cFE#1237 - Fix #1180, Removes impossible conditions nasa/cFE#1240 - Fix #1002, Remove deprecated elements nasa/cFE#1253 - Fix #1252, Squash potentially uninitialized variable warnings nasa/cFE#1241 - Fix #1185, Squash possible uninitialized variable false alarms nasa/cFE#1247 - Fix #1246, Typo in CFE_TBL_Validate AppName nasa/cFE#1234 - Fix #1192, Initialize TotalMsgSize in CFE_SB_GetUserDataLength nasa/cFE#1245 - Fix #1187, Increment CreatePipeErrorCounter for all create pipe errors nasa/cFE#1236 - Fix #1186, Remove useless assignments/checks nasa/cFE#1237 - Fix #1180, Removes impossible conditions nasa/cFE#1240 - Fix #1002, Remove deprecated elements nasa/cFE#1253 - Fix #1252, Squash potentially uninitialized variable warnings nasa/cFE#1241 - Fix #1185, Squash possible uninitialized variable false alarms nasa/cFE#1247 - Fix #1246, Typo in CFE_TBL_Validate AppName nasa/cFE#1234 - Fix #1192, Initialize TotalMsgSize in CFE_SB_GetUserDataLength nasa/cFE#1245 - Fix #1187, Increment CreatePipeErrorCounter for all create pipe errors nasa/cFE#1236 - Fix #1186, Remove useless assignments/checks nasa/cFE#1262 - Fix #1239, scrub include header guards nasa/cFE#1256 - Fix #1194, check for NULL in SlotUsed helpers nasa/cFE#1263 - Fix #1261, removed redundant checks for CFE_SUCCESS nasa/cFE#1250 - Fix #1215, remove task registration calls nasa/cFE#1242 - Fix #1223, shorten TestRunner function name nasa/cFE#1242 - Fix #1264, Convert functional test startup script example to use "simple" filenames nasa/cFE#1229 - Fix #1164, use FS file name parser for commands nasa/cFE#1257 - Fix #1155, clean up zero copy API nasa/cFE#1254 - Fix #1181, global variable cleanup nasa/cFE#1255 - Fix #1206, report PSP version in ES HK TLM nasa/cFE#1271 - Fix #1270, limit check in pool validation nasa/cFE#1268 - Fix #1267, add null pointer check nasa/cFE#1268 - Fix #1269, replace CFE_ES_ERR_BUFFER return for invalid null pointer arguments nasa/cFE#1260 - Fix #1259, adds --branch-coverage option to genhtml line in lcov Makefile rule nasa/osal#878 - Fix #843, remove BIG/LITTLE bit order macros nasa/osal#918 - Fix #846, Minor clean up and clarification in comments/namin nasa/osal#923 - Fix #831, Finish os-impl-bsd-socket.c coverage testing nasa/osal#915 - Fix #888, better return codes from OS_SymbolTableDump_Impl nasa/osal#926 - Fix #853, remove OS_TaskRegister nasa/osal#935 - Fix #934, Remove unused SCRIPT_MODE flag nasa/osal#930 - Fix #929, use test function for osal_id_t nasa/PSP#276 - Fix #275, Adds a UT stub for CFE_PSP_GetKernelTextSegmentInfo nasa/PSP#278 - Fix #277, add version file nasa/ci_lab#83 - Fix #82, remove app registration nasa/ci_lab#84 - Fix #73, use zero copy API nasa/sample_app#139 - Fix #138, remove app registration nasa/sample_app#143 - Fix #142, scrub header guards nasa/sch_lab#75 - Fix #74, remove app registration nasa/to_lab#96 - Fix #95, remove app registration
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the contribution
All C header files should have a header guard matching the file name of the header, in ALL_CAPS, with no extra leading/trailing
underscores.
This also takes a first pass at converting the file-scope block comments to a doxygen format to include a summary of the file.
Fixes #1239
Testing performed
Build and sanity check CFE, build and run all unit tests
Build documentation and confirm the content of "Detailed Description" on the files contains the info from
@filedoxygen blocks.Expected behavior changes
No impact to behavior.
System(s) tested on
Ubuntu 20.04
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.