Skip to content

Fix #540, User's guide scrub#555

Closed
skliper wants to merge 7 commits intonasa:masterfrom
skliper:fix540-usersguide-scrub
Closed

Fix #540, User's guide scrub#555
skliper wants to merge 7 commits intonasa:masterfrom
skliper:fix540-usersguide-scrub

Conversation

@skliper
Copy link
Contributor

@skliper skliper commented Mar 13, 2020 •
edited
Loading

Describe the contribution
Documentation/comments only included in this change.

Commit 784fe09

Commit 0f60675

Commit 7e248ba

Commit 71df47f

Commit 0c00f71

Testing performed
Steps taken to test the contribution:

  1. Standard make/build steps to confirm code wasn't broken
  2. make usersguide
  3. confirmed build/doc/warnings.log (doxygen warnings) empty
  4. cd build/doc/usersguide/latex
  5. make (to build the pdf)

Expected behavior changes
User's guide generates and and creates pdf without errors

System(s) tested on

  • Hardware: cFS Dev Server
  • OS: Ubuntu 18.04
  • Versions: master bundle w/ this commit

Additional context
Does not attempt to address #508 and #389

Third party code
None

Contributor Info - All information REQUIRED for consideration of pull request
Jacob Hageman - NASA/GSFC

Jacob Hageman added 2 commits March 3, 2020 14:20
@skliper skliper added this to the 6.8.0 milestone Mar 13, 2020
@skliper skliper force-pushed the fix540-usersguide-scrub branch from 3adf48d to 3c1765a Compare March 13, 2020 18:49
Jacob Hageman added 5 commits March 13, 2020 15:27
Fix nasa#540, Scrub User's Guide and related comments
784fe09 
NOTE - Comments/documentation only, no logic updates
Also fixes nasa#403, resolves all warnings
Also fixes nasa#536, comment typo in CFE_SB_RcvMsg implementation header
Fix nasa#261, Clarify table never loaded error
0f60675 
Documentation/comment change only.
Moved get address specific information from error code to API.
Fix nasa#267, Document SysLog vs Event use
7e248ba 
Documentation/comment only
Fix nasa#499, Clarify Get/SetMsgTime effect on cmd msg
71df47f 
Partial fix (see also nasa#545), comments/documentation only
Fix nasa#531, Doc MID use for CFE_TBL_NotifyByMessage
0c00f71 
Documentation/comments only
Recommends unique MID for inter-app communications
@skliper skliper force-pushed the fix540-usersguide-scrub branch from 3c1765a to 0c00f71 Compare March 13, 2020 19:28
@skliper skliper changed the title WIP: Fix #540, User's guide scrub Fix #540, User's guide scrub Mar 13, 2020
@skliper skliper added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Mar 13, 2020
@skliper skliper mentioned this pull request Mar 15, 2020
Closed
@skliper
Copy link
Contributor Author

skliper commented Mar 15, 2020

cFE_Users_Guide.pdf

See attached for results. Might be worth attempting to push CI build to keep documentation up to date?

@astrogeco astrogeco added the docs This change only affects documentation. label Mar 18, 2020
@astrogeco
Copy link
Contributor

astrogeco commented Mar 18, 2020

CCB Approved - 20200318
This affected docs warning -> created #559 to address

@skliper skliper linked an issue Mar 18, 2020 that may be closed by this pull request
API header documentation doesn't match c file documentation #528
Closed
@astrogeco astrogeco added CCB - 20200318 CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Mar 18, 2020
@astrogeco
Copy link
Contributor

astrogeco commented Mar 23, 2020

Closing PR: Relevant commits added in PR #558

@astrogeco astrogeco closed this Mar 23, 2020
@astrogeco astrogeco mentioned this pull request Mar 23, 2020
Merged
@skliper skliper deleted the fix540-usersguide-scrub branch February 1, 2021 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment