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

return value of CFE_SB_ReceiveBuffer stub does not match documentation #1055

Closed
CDKnightNASA opened this issue Jan 4, 2021 · 2 comments · Fixed by #1463
Closed

return value of CFE_SB_ReceiveBuffer stub does not match documentation #1055

CDKnightNASA opened this issue Jan 4, 2021 · 2 comments · Fixed by #1463
Assignees
Labels
docs This change only affects documentation. enhancement
Milestone

Comments

@CDKnightNASA
Copy link
Contributor

For the stock stub function, it returns the default (CFE_SUCCESS) return code but sets the message pointer to NULL. The documentation states that it defaults to return the TIMEOUT error. The logic for the stub may want to reflect this.

** CFE_SB_ReceiveBuffer. By default it will return the TIMEOUT error response,

@skliper
Copy link
Contributor

skliper commented Jan 4, 2021

Probably worth making it like the other (new-ish) getters, in that it will report an error if the SB buffer has not been provided already (from the UT buffer). Then can remain as the default success (like the other stubs).

@skliper skliper added this to the 7.0.0 milestone Jan 4, 2021
CDKnightNASA added a commit to CDKnightNASA/cFE that referenced this issue Jan 5, 2021
@CDKnightNASA CDKnightNASA self-assigned this Jan 5, 2021
CDKnightNASA added a commit to CDKnightNASA/cFE that referenced this issue Jan 6, 2021
@skliper skliper added enhancement docs This change only affects documentation. labels Jan 22, 2021
@skliper
Copy link
Contributor

skliper commented Jan 26, 2021

This has become a documentation issue (comments on stub description are incorrect).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change only affects documentation. enhancement
Projects
None yet
2 participants