Fix #1337, add docs to CFE_ES_RegisterCDS() regarding clearing #1376
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
Note in the documentation for this function that it is the responsibility of the calling app to clear/fill the CDS block any time a new block is allocated.
Fixes #1337
Testing performed
Build and sanity check.
Expected behavior changes
None - Documentation only.
System(s) tested on
Ubuntu 20.04
Additional context
Don't recommend changing this behavior, it could easily break something or have unintended consequences, but should be clear in docs that a new CDS block must be written to before using, and it is the app/caller responsibility to do so.
Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.