Add convenience header: os/mynewt.h #969
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This new header (
os/mynewt.h) includes the following headers:syscfg/syscfg.hsysinit/sysinit.hsysflash/sysflash.hos/os.hdefs/error.hThis header is intended to be included before any other non-system headers. The purpose of this header is to make an application developer's job easier, and simplify the "getting started" process.
I think a good rule of thumb is: always include
os/mynewt.hand never directly include any of the headers listed above.I put this header in the
kernel/ospackage because, in practice, every other package has access to this one. I am happy to move it somewhere else if there are alternative ideas.I was tempted to include
bsp/bsp.hin this header, but I decided it is better if Mynewt doesn't make any assumptions about which files the BSP exports.I tested this PR with
newt test alland by successfully building the following targets (most target definitions can be inferred from their names):