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

Duplicate Function in Readme #1277

Closed
ArielSAdamsNASA opened this issue Apr 1, 2021 · 3 comments · Fixed by #1278 or #1279
Closed

Duplicate Function in Readme #1277

ArielSAdamsNASA opened this issue Apr 1, 2021 · 3 comments · Fixed by #1278 or #1279
Labels
docs This change only affects documentation.
Milestone

Comments

@ArielSAdamsNASA
Copy link

Describe the bug
In the version history of the readme, it states:

Removes the now-unnecessary CFE_SB_ZeroCopyHandle_t type and all APIs that refer or require it .Replaces CFE_SB_ZeroCopyGetPtr() and CFE_SB_ZeroCopyGetPtr() with two new simplified functions CFE_SB_AllocateMessageBuffer() and CFE_SB_ReleaseMessageBuffer() , respectively. These new functions do not use a separate handle. Updates the CFE_SB_TransmitBuffer() API to also remove the handle. Does affect public APIs.

The issue is that the version history is stating that the same function, CFE_SB_ZeroCopyGetPtr, is being replaced by two different functions.

In reality, CFE_SB_ZeroCopyGetPtr was replaced by CFE_SB_AllocateMessageBuffer. CFE_SB_ZeroCopyReleasePtr and CFE_SB_ZeroCopySend, not CFE_SB_ZeroCopyGetPtr, was replaced by CFE_SB_ReleaseMessageBuffer.

Expected behavior
State that CFE_SB_ZeroCopyReleasePtr and CFE_SB_ZeroCopySend, not CFE_SB_ZeroCopyGetPtr, was replaced by CFE_SB_ReleaseMessageBuffer.

Code snips
https://github.com/nasa/cFE/pull/1257/files

Reporter Info
Ariel Adams, ASRC Federal

@ArielSAdamsNASA ArielSAdamsNASA added the docs This change only affects documentation. label Apr 1, 2021
@skliper
Copy link
Contributor

skliper commented Apr 2, 2021

Note CFE_SB_ZeroCopySend was replaced by CFE_SB_TransmitBuffer. CFE_SB_ZeroCopyReleasePtr was replaced by CFE_SB_ReleaseMessageBuffer.

@astrogeco
Copy link
Contributor

Good catch, I think this was a copy paste error from a typo in the original PR.

astrogeco added a commit that referenced this issue Apr 2, 2021
Fixes mislabeled function in v6.8.0-rc1+dev484 change description
@astrogeco
Copy link
Contributor

Just fixed it in the comments for #1257 and #1258. Created a new PR, #1278, to fix it.

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.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants