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.

Sign up for GitHub

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

Jump to bottom

Document deprecation process #67

Open
skliper opened this issue Apr 15, 2020 · 1 comment
Open

Document deprecation process #67

skliper opened this issue Apr 15, 2020 · 1 comment
Labels
docs

Comments

@skliper
Copy link
Contributor

skliper commented Apr 15, 2020

Is your feature request related to a problem? Please describe.
Process not documented

Describe the solution you'd like
Document process and reference.

  • Issue requesting deprecation gets reviewed by CCB, accepted/assigned or rejected
    • evaluate requirements/documentation/operational impacts
  • Pull request(s) wraps deprecated elements in *_OMIT_DEPRECATED ifndef and removes any internal dependencies
    • Default sample configuration does not remove this code
    • make OMIT_DEPRECATED=true prep will compile without it to check code for compliance
    • ideally any deprecated elements address dependency fix (use new element, no longer supported, etc)
    • elements can be deprecated in any build/release
    • CI tests with and without deprecated elements removed to ensure no internal dependencies
  • Issue requesting removal of deprecated code
  • Pull request removes deprecated elements
    • typically done end of cycle prior to a major release

Describe alternatives you've considered
Wing it.

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC
@skliper skliper added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Apr 15, 2020
@skliper skliper mentioned this issue Apr 15, 2020
Closed
@astrogeco astrogeco added docs CCB - 20200422 and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Apr 21, 2020
@skliper
Copy link
Contributor Author

skliper commented Jul 23, 2020

Suggest adding to a cfe/docs/src/*.dox file and referencing such that it gets into the autogenerated documentation.

@skliper skliper mentioned this issue Aug 5, 2020
Merged
chillfig pushed a commit to chillfig/cFS that referenced this issue Mar 17, 2022
@jphickey
Fix nasa#67, remove use of bitfields in CF
1b6487c 
Bit field behavior is platform-specific, bits are not
specified to be in any particular order. Furthermore,
unions of bitfields are likely undefined behavior.

This removes the bitfields and replaces with normal
fields.
chillfig pushed a commit to chillfig/cFS that referenced this issue Mar 17, 2022
@astrogeco
Merge pull request nasa#103 from jphickey/fix-67-bitfields
1725cd0 
Fix nasa#67, remove use of bitfields in CF
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@skliper @astrogeco