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 #640, configuration guide updates #978

Merged
merged 2 commits into from
May 11, 2021

Conversation

jphickey
Copy link
Contributor

Describe the contribution
Significant update to the configuration guide for the current build system (CMake) and the currently provided set of OS/BSP layers. Many of the examples in this guide referred to items which are now obsolete.

However, this does NOT fix references to the applications and in particular the "tasking example" as this still may be brought back.

Fixes #640

Testing performed
View guide in markdown viewer, confirm commands/pathnames in guide seem to match current version

Expected behavior changes
None - documentation only

System(s) tested on
Commands in document were validated on Linux and RTEMS where possible

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

Update the configuration guide for the current build system (CMake)
and the currently provided set of OS/BSP layers.  Many of the
examples in this guide referred to items which are obsolete.

However, this does *NOT* fix references to the applications and
in particular the "tasking example" as this still may be brought back.
@jphickey jphickey added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Apr 30, 2021
doc/OSAL-Configuration-Guide.md Show resolved Hide resolved

Note that the OSAL is not typically built as a standalone library; although a standalone
build can be done for testing and development purposes, it is expected that the OSAL will
be utilized as a component in a larger application.

### Integrating OSAL into a larger build
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this, ping @ejtimmon for reference to reviving the tasking examples and adding c++ hello world

doc/OSAL-Configuration-Guide.md Outdated Show resolved Hide resolved
doc/OSAL-Configuration-Guide.md Outdated Show resolved Hide resolved
@astrogeco
Copy link
Contributor

CCB:2021-05-05 APPROVED with changes

  • Removes all "classic build system"
  • Review comments

Copy link
Contributor

@astrogeco astrogeco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes as a reminder to look at comments

@astrogeco astrogeco added the CCB:Approved Indicates code review and approval by community CCB label May 5, 2021
jphickey added a commit to jphickey/osal that referenced this pull request May 6, 2021
Adds various review items into the document, adds some new
sections regarding the sample Makefile wrapper.
jphickey added a commit to jphickey/osal that referenced this pull request May 6, 2021
Adds various review items into the document, adds some new
sections regarding the sample Makefile wrapper.
Adds various review items into the document, adds some new
sections regarding the sample Makefile wrapper.
@astrogeco astrogeco added IC:2021-05-11 and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels May 11, 2021
@astrogeco astrogeco changed the base branch from main to integration-candidate May 11, 2021 01:46
@astrogeco astrogeco merged commit 4d8fb3c into nasa:integration-candidate May 11, 2021
astrogeco added a commit to nasa/cFS that referenced this pull request May 11, 2021
nasa/osal#978, configuration guide updates

nasa/osal#974, improve documentation of UtAssert API calls

nasa/osal#977, update OS_TaskCreate doc
astrogeco added a commit to nasa/cFS that referenced this pull request May 12, 2021
nasa/cFE#1492, cFE v6.8.0-rc1+dev575
nasa/osal#996, osal v5.1.0-rc1+dev434

nasa/cFE#1487, Remove broken travis-ci script
nasa/cFE#1463, generated coverage stubs for CFE core
nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API
nasa/cFE#1451, OSAL config file simplification
nasa/cFE#1489, removes --quiet option so files checked go to stdout

nasa/osal#978, configuration guide updates
nasa/osal#974, improve documentation of UtAssert API calls
nasa/osal#977, update OS_TaskCreate doc
nasa/osal#997, Enable cppcheck results output
nasa/osal#980, Scrub return values
nasa/osal#992, add local mutex to BSP console
nasa/osal#993, do not require nonblock mode
astrogeco added a commit to nasa/cFS that referenced this pull request May 12, 2021
nasa/cFE#1492, cFE v6.8.0-rc1+dev575
nasa/osal#996, osal v5.1.0-rc1+dev434

nasa/cFE#1487, Remove broken travis-ci script
nasa/cFE#1463, generated coverage stubs for CFE core
nasa/cFE#1463, Move CFE_FS_RunBackgroundFileDump to internal API
nasa/cFE#1451, OSAL config file simplification
nasa/cFE#1489, removes --quiet option so files checked go to stdout

nasa/osal#978, configuration guide updates
nasa/osal#974, improve documentation of UtAssert API calls
nasa/osal#977, update OS_TaskCreate doc
nasa/osal#997, Enable cppcheck results output
nasa/osal#980, Scrub return values
nasa/osal#992, add local mutex to BSP console
nasa/osal#993, do not require nonblock mode

Co-authored-by: Jacob Hageman <jacob.hageman@nasa.gov>
Co-authored-by: Joseph Hickey <joseph.p.hickey@nasa.gov>
@jphickey jphickey deleted the fix-640-configguide branch May 14, 2021 13:55
@skliper skliper added this to the 6.0.0 milestone Sep 24, 2021
jphickey added a commit to jphickey/osal that referenced this pull request Aug 10, 2022
Implement a "CFE_ES_TaskStartParams_t" to complement the
existing "CFE_ES_AppStartParams_t" and store this in the
task record.

This permits some nice cleanup:

- All tasks can now use the same basic start function CFE_ES_StartAppTask()
- No special/different logic is needed for main tasks/child tasks
- Simplified APIs as parameters can be encapsulated in a single struct.
- Fixes a race condition where child tasks may not be fully instantiated
  at the time the task function is invoked.
jphickey pushed a commit to jphickey/osal that referenced this pull request Aug 10, 2022
Fix nasa#978, put task parameters into task record
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
3 participants