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.

Sign up for GitHub

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

Jump to bottom

CFE_SB_GetPipeName stub doc references UT_pipename? #1059

Closed
CDKnightNASA opened this issue Jan 4, 2021 · 0 comments · Fixed by #1060 or #1066
Closed

CFE_SB_GetPipeName stub doc references UT_pipename? #1059

CDKnightNASA opened this issue Jan 4, 2021 · 0 comments · Fixed by #1060 or #1066
Assignees
@CDKnightNASA
Labels
docs This change only affects documentation. unit-test
Milestone
Caelum

Comments

@CDKnightNASA
Copy link
Contributor

The documentation for the CFE_SB_GetPipeName stub references setting UT_pipename...which AFAICT is not defined/used. I'm assuming that users should use UT_SetDataBuffer(UT_KEY(CFE_SB_GetPipeName)...).

cFE/fsw/cfe-core/ut-stubs/ut_sb_stubs.c

Line 204 in 56397a3

** CFE_SB_GetPipeName. The user must set the value of UT_pipename prior

@CDKnightNASA CDKnightNASA changed the title UT_pipename? CFE_SB_GetPipeName stub doc references UT_pipename? Jan 4, 2021
@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 4, 2021
@CDKnightNASA
fix nasa#1059 - corrects documentation for CFE_SB_GetPipeName() stub
908c2c1
@CDKnightNASA CDKnightNASA mentioned this issue Jan 4, 2021
Merged
@CDKnightNASA CDKnightNASA self-assigned this Jan 4, 2021
astrogeco added a commit that referenced this issue Jan 6, 2021
@astrogeco
Merge pull request #1060 from CDKnightNASA/fix-1059-getpipename_stub_doc
3b721df 
Fix #1059, Correct documentation for CFE_SB_GetPipeName() stub
@astrogeco astrogeco mentioned this issue Jan 7, 2021
Merged
@astrogeco astrogeco added the docs This change only affects documentation. label Jan 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@CDKnightNASA CDKnightNASA

Labels
docs This change only affects documentation. unit-test
Projects
None yet
Milestone
Caelum
3 participants
@CDKnightNASA @skliper @astrogeco