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

Comments/document cleanup relative to SB/MSG/SBR review (and #1375) #1452

Closed
skliper opened this issue Apr 29, 2021 · 0 comments · Fixed by #1570 or #1584
Closed

Comments/document cleanup relative to SB/MSG/SBR review (and #1375) #1452

skliper opened this issue Apr 29, 2021 · 0 comments · Fixed by #1570 or #1584
Labels
cFE-MSG cFE-SB cFE-SBR CFS-42 docs This change only affects documentation.
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Apr 29, 2021

Is your feature request related to a problem? Please describe.
Clarify CCSDS comment, just note CCSDS maximum is 7 bigger than int16:

typedef size_t CFE_MSG_Size_t; /**< \brief Message size (CCSDS needs uint32 for max size) */

Add link to options in documentation:

** \param[in] Opts A bit field of options.

Clarify comments to eliminate implied coupling (SBN is an example use):

** Subscription Reporting is enabled for interprocessor communication
** by way of the Software Bus Network (SBN) Application.

Mention CFE_SB_ReleaseMessageBuffer for the case when a message is not transmitted in CFE_SB_AllocateMessageBuffer:

** \brief Get a buffer pointer to use for "zero copy" SB sends.

Extra a in comment:

* \brief Add a route for the given a message id

Comment in CFE_SB_UnsubscribeFull about CFE_SUCCESS status should be brought up to the else level, everything is success and explicitly mention in API documentation:

/* Status stays CFE_SUCCESS here */

s/bush/bus:

message(ERROR "Invalid software bush routing implementation selected:" MISSION_MSGMAP_IMPLEMENTATION)

Fix comment, doesn't pad to boundary, instead pads to be divisible by 64 so compiler won't add padding if payload structure requires 64 bit alignment:

uint8 Spare[4]; /**< \brief Padding to end on 64 bit boundary */

uint8 Spare[4]; /**< /brief Padding to end on 64 bit boundary */

Describe the solution you'd like
Fix

Describe alternatives you've considered
None

Additional context
Code review

Requester Info
Jacob Hageman - NASA/GSFC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cFE-MSG cFE-SB cFE-SBR CFS-42 docs This change only affects documentation.
Projects
None yet
2 participants