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

Update function header comments on "ng" implementation functions #263

Closed
skliper opened this issue Sep 30, 2019 · 4 comments
Closed

Update function header comments on "ng" implementation functions #263

skliper opened this issue Sep 30, 2019 · 4 comments
Assignees
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Sep 30, 2019

Action item from vxworks-ng review held on 2019-08-27:

Across posix-ng, rtems-ng, and vxworks-ng, the implementation functions have header comments that were cut and paste from the original implementation and may not reflect the actual code anymore.

This should be scrubbed prior to the OSAL release.

@skliper skliper added this to the osal-5.0.0 milestone Sep 30, 2019
@skliper skliper self-assigned this Sep 30, 2019
@skliper
Copy link
Contributor Author

skliper commented Sep 30, 2019

Imported from trac issue 240. Created by jphickey on 2019-08-27T16:41:36, last modified: 2019-09-10T09:15:46

@skliper skliper added the bug label Sep 30, 2019
@skliper
Copy link
Contributor Author

skliper commented Sep 30, 2019

Trac comment by jphickey on 2019-09-09 10:10:16:

For resolving this I propose to put the corrected comments/descriptions in the "os-impl.h" file and //remove// them from the C file, or at least replace the ones in the C file with a simpler/shorter comment that refers back to the header file for detail.

The reason is that all three implementations share a common "os-impl.h" header file. Putting it in the C source means copying it at least 3 times, this will become another maintenance issue. (actually partly the cause of the current problem, things just got copied/pasted).

@skliper
Copy link
Contributor Author

skliper commented Sep 30, 2019

Trac comment by jhageman on 2019-09-10 09:15:46:

Agree completely, describe in os-impl.h, remove from c files.

Please transfer this issue to github and apply changes to the release candidate branch.

@skliper
Copy link
Contributor Author

skliper commented Oct 2, 2019

Closing as duplicate of #17

@skliper skliper closed this as completed Oct 2, 2019
jphickey added a commit to jphickey/osal that referenced this issue Aug 10, 2022
This also more properly defines the the CFE_SB_INVALID_MSG_ID macro for
external use going forward.
jphickey added a commit to jphickey/osal that referenced this issue Aug 10, 2022
Manually merged to resolve conflicts.

From branch jphickey/fix-263-msgid-api:

Fix nasa#245, Consistent use of MsgId type
Fix nasa#263, Expose CFE_SB_IsValidMsgId() API

From branch dmknutsen/issue_240:

Fixes nasa#240, removes MESSAGE_FORMAT_IS_CCSDS ifdefs from code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants