Add documentation of Unmanaged Bootloader builds #158
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
(for the second time)
docs/advanced/bootloader.md
Outdated
| ## Creating the bootloader | ||
| ## mbed OS managed bootloader | ||
|
|
||
| The tools of mbed OS know how to manage some bootloader projects. The tools can manage bootloader projects where the bootlodoader comes before the application in ROM and the application starts immediately after the bootloader. If your bootloader does not meet both of these requirements, then please read the [unmanaged bootloader section](bootloader.md#unmanaged-bootloader). A managed bootloader project automatically merge the bootloader image with the application image as part of the application image build process. |
There was a problem hiding this comment.
Please change "automatically merge" to "automatically merges".
docs/advanced/bootloader.md
Outdated
|
|
||
| ## Unmanaged bootloader | ||
|
|
||
| You want to have an unmanaged bootloader when your bootloader's requirements conflict with the requirements of the managed bootloader. You need an unmanaged bootloader when your bootloader does not come before your application in ROM or your application does not start immediately after your bootloader. Unlike a managed bootloader, an unmananged bootloader does not automatically merge the bootloader image with the application image after building the application. We expect users of an unmanaged bootloader build to construct there own set of scripts built atop the `mbed compile` primitive to perform bootloader and application merging. |
There was a problem hiding this comment.
Please change "there own set" to "their own set".
docs/advanced/bootloader.md
Outdated
|
|
||
| ### `target.mbed_app_start` | ||
|
|
||
|
|
There was a problem hiding this comment.
Please delete extra line.
docs/advanced/bootloader.md
Outdated
| ### `target.mbed_app_start` | ||
|
|
||
|
|
||
| The configuration option `target.mbed_app_start` sets the starting address of the linker script by defining the `MBED_APP_START` macro for the linker script. You may only define this configuration option within the `target_overrides` section of an mbed application configuration, and you may not define it for the meta-target `*`. When you do not define this configuration option, it defaults to the start of a target's ROM. This configuration option must be an address within ROM. |
There was a problem hiding this comment.
Please delete the hyphen in "metatarget".
docs/advanced/bootloader.md
Outdated
|
|
||
| ### `target.mbed_app_size` | ||
|
|
||
| The configuration option `target.mbed_app_size` defines the size of an application image in ROM by defining the `MBED_APP_SIZE` macro for the linker script. You may only define this configuration option on a per-target basis defined within the `target_overrides` section of an mbed application configuration, and you may not define it for the meta-target `*`. When you do not define this configuration option, it defaults to the remaining ROM, which the mbed OS tools calculate by subtracting the image's offset into ROM from the total size of ROM. Together with `target.mbed_app_start`, these configuration options define a continuous region of memory that an image may use. The tools verify that this region of memory is in ROM, but the tools do not perform any other checks for consistency or validity. |
There was a problem hiding this comment.
- Please delete the hyphen in "metatarget".
- Please delete the extra space between "to the" and "remaining ROM".
- Consider splitting the third sentence into two shorter sentences.
|
@AnotherButler Fixed |
|
@AnotherButler The dependent PR on mbed-os was merged. LGTM! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Documentation for ARMmbed/mbed-os#4202
DO NOT MERGE BEFORE ARMmbed/mbed-os#4202 IS MERGED