Fix #485 - add text to make clear that IDs are non-zero #486
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
jphickey
approved these changes
Jun 1, 2020
There was a problem hiding this comment.
Looks good.
Is there any sort of "main page" that this could be added to? It will also apply to any future osal ID types in the event that we add new ones someday.
It is also a design pattern that I recommend applying across all of CFE (app IDs, pipe IDs, message IDs, etc.). When zero'ed out memory aliases a real object, that's not good.
https://github.com/nasa/cFE/blob/master/docs/src/osalmain.dox |
skliper
approved these changes
Jun 3, 2020
|
CCB-2020-06-03: APPROVED, @CDKnightNASA Open new ticket for osal pattern documentation |
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
Fix #485 - adds "non-zero" to the out variable description for OS_Create (and related) API's.
Contributor Info - All information REQUIRED for consideration of pull request
[email protected]