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

Fix #364 and others, Scrub user's guide #371

Merged
merged 4 commits into from
Mar 23, 2020

Conversation

skliper
Copy link
Contributor

@skliper skliper commented Mar 15, 2020

Describe the contribution
Document/comment changes only
Fix #364 - see issue for detailed changes
Fix #70 - since old doc was removed, and autodoc is correct

Fix #10 - replicated changes to old document in API header comments in 1aa87de
Fix #225 - documented callback restrictions 4b19a1a
Fix #116 - document OS dependent behavior on open files 8f0780e

Partially addresses #255, #12, #18, #366

Testing performed
Steps taken to test the contribution:

  1. Nominal build (native) and run, no issues
  2. Make usersguide and confirmed no warnings in build/doc/warnings
  3. cd build/doc/users_guide/latex
  4. make
  5. confirm completes and guide looks ok
  6. Make osalguide and confirmed no warnings in build/doc/warnings
  7. cd build/doc/osalguide/latex
  8. make
  9. confirm completes and guide looks ok

Expected behavior changes
No behavior change other than warnings resolved for doc build

System(s) tested on

  • Hardware: cFS Dev Server 3
  • OS: Ubuntu 18.04
  • Versions: Bundle w/ the commits below

Additional context
None

Third party code
None

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

Document/comment changes only
Partially addresses nasa#255, nasa#12, nasa#18, nasa#366
Replicated changes to old documents that were
done previously.  Document/comment change only.
@skliper skliper added enhancement CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Mar 15, 2020
@skliper
Copy link
Contributor Author

skliper commented Mar 15, 2020

OSAL_Users_Guide.pdf

See attached results.

@skliper skliper changed the title Fix #364, Scrub user's guide Fix #364 and others, Scrub user's guide Mar 16, 2020
@astrogeco astrogeco added the docs label Mar 18, 2020
@astrogeco
Copy link
Contributor

CCB Approved - 20200318

@astrogeco astrogeco added CCB - 20200318 CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Mar 18, 2020
@astrogeco astrogeco changed the base branch from master to integration-candidate March 23, 2020 16:55
@astrogeco astrogeco merged commit d6c71aa into nasa:integration-candidate Mar 23, 2020
@skliper skliper added this to the 5.1.0 milestone Jun 1, 2020
@skliper skliper deleted the fix364-userguide-scrub branch February 1, 2021 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment