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 #42, naming conventions and style compliance #98

Merged
merged 9 commits into from
Dec 9, 2021

Conversation

jphickey
Copy link
Contributor

@jphickey jphickey commented Dec 7, 2021

Update identifier names across CF source code to match the CFS naming convention. This convention is documented in the CFE framework, see https://github.com/nasa/cFE/blob/main/docs/cFS_IdentifierNamingConvention.md

Changes are mostly just search/replace. Each file will be done separately, to keep the commit size within reason. But these will not likely be easy to merge/split due to the number of lines affected so they need to be maintained as a series.

Fixes #42

@jphickey jphickey force-pushed the fix-42-naming-conventions branch 2 times, most recently from 30464ce to 300e7ce Compare December 8, 2021 14:26
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Dec 8, 2021
@jphickey
Copy link
Contributor Author

jphickey commented Dec 8, 2021

Preemptively marked as ready, this just needs a fresh baseline but can be initially reviewed. Real change starts from b55cf70

@astrogeco astrogeco removed the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Dec 8, 2021
@astrogeco
Copy link
Contributor

CCB:2021-12-08 - APPROVED

  • What is the difference between CF_* and CF_CFDP*?
    • CF_CFDP_* items are defined by the "blue book"

Updates names of all identifiers declared in cf_cfdp_pdu.h to adhere
to naming conventions.

This also updates documentation on many of the items in cf_cfdp_pdu.h
Updates names of all identifiers in cf_cfdp.h to follow naming
conventions from CFE.
Updates names of all identifiers in cf_chunk.h to follow naming
conventions from CFE.
Update names of all identifiers in cf_clist.h to follow naming
conventions from CFE.
Updates names of all identifiers in cf_crc.h to follow naming
conventions from CFE.
Updates names of all identifiers in cf_msg.h to follow naming
conventions from CFE.
Updates names of all identifiers in cf_timer.h and cf_utils.h to follow naming
conventions from CFE.
…fy.h

Updates names of all identifiers in cf_version.h and cf_verify.h to follow naming
conventions from CFE.

This only affects include guards
Updates names of all identifiers in platform_inc to follow naming
conventions from CFE.
@jphickey jphickey marked this pull request as ready for review December 9, 2021 15:42
@jphickey
Copy link
Contributor Author

jphickey commented Dec 9, 2021

This has been rebased to "main" now that all the dependencies are satisfied. Should be OK to merge.

@astrogeco astrogeco merged commit a894069 into nasa:main Dec 9, 2021
@jphickey jphickey deleted the fix-42-naming-conventions branch December 9, 2021 16:39
@skliper skliper added this to the Draco milestone Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CF Code Style and Coding standards compliance
3 participants