Skip to content

Commit 5bc9832

Browse files
FrancescoSernvlsianpu
authored andcommitted
doc: Fix case in titles
Unified case in titles. Fixed small grammar issues. Signed-off-by: Francesco Servidio <[email protected]>
1 parent a6df132 commit 5bc9832

17 files changed

+49
-49
lines changed

boot/cypress/BlinkyApp/Readme.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Blinking LED test application for MCUboot Bootloader
1+
### Blinking LED test application for MCUboot bootloader
22

33
### Description
44

@@ -109,7 +109,7 @@ To obtain encrypted upgrade image of BlinkyApp extra flag `ENC_IMG=1` should be
109109

110110
This also suggests user already placed corresponing `*.pem` key in `\keys` folder. The key variables are defined in root `Makefile` as `SIGN_KEY_FILE` and `ENC_KEY_FILE`
111111

112-
### Post-Build
112+
### Post-build
113113

114114
Post build action is executed at compile time for `BlinkyApp`. In case of build for `PSOC_062_2M` platform it calls `imgtool` from `MCUboot` scripts and adds signature to compiled image.
115115

boot/cypress/MCUBootApp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Since this application is created to demonstrate MCUboot library features and no
124124
2. `CY_SMIF_SLAVE_SELECT_0` is used as definition SMIF driver API. This configuration is used on evaluation kit for this example CY8CPROTO-062-4343W, CY8PROTO-062S3-4343W, CY8CKIT-062-4343W. If you try to use custom hardware with this application - change value of `smif_id` in `main.c` of MCUBootApp to value that corresponds to your design.
125125

126126

127-
### Downloading Solution's Assets
127+
### Downloading solution's assets
128128

129129
There is a set assets required:
130130

@@ -137,7 +137,7 @@ To get submodules - run the following command:
137137

138138
git submodule update --init --recursive
139139

140-
### Building Solution
140+
### Building solution
141141

142142
This folder contains make files infrastructure for building MCUBoot Bootloader. Same approach used in sample BlinkyLedApp application. Example command are provided below for couple different build configurations.
143143

boot/cypress/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Refer to **Cypress Semiconductors** [github](https://github.com/cypresssemicondu
1111
1. MCUboot-Based Basic Bootloader [mtb-example-psoc6-mcuboot-basic](https://github.com/cypresssemiconductorco/mtb-example-psoc6-mcuboot-basic)
1212
2. MCUboot-Based Bootloader with Rollback to Factory App in External Flash [mtb-example-anycloud-mcuboot-rollback](https://github.com/cypresssemiconductorco/mtb-example-anycloud-mcuboot-rollback)
1313

14-
### Solution Description
14+
### Solution description
1515

1616
There are two applications implemented:
1717
* MCUBootApp - PSoC6 MCUboot-based bootloading application;
@@ -31,7 +31,7 @@ For more details about External Memory usage, please refer to separate guiding d
3131

3232
MCUBootApp checks image integrity with SHA256, image authenticity with EC256 digital signature verification and uses either completely software implementation of cryptographic functions or accelerated by hardware - both based on Mbed TLS Library.
3333

34-
### Downloading Solution's Assets
34+
### Downloading solution's assets
3535

3636
There is a set assets required:
3737

@@ -52,7 +52,7 @@ Submodules can also be updated and initialized separately:
5252

5353

5454

55-
### Building Solution
55+
### Building solution
5656

5757
Root directory for build is **boot/cypress.**
5858

docs/PORTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Porting How-To
1+
# Porting how-to
22

33
This document describes the requirements and necessary steps required to port
44
`MCUboot` to a new target `OS`.

docs/SECURITY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MCUboot project security policy
22

3-
## Reporting Security Issues
3+
## Reporting security issues
44

55
The MCUboot team takes security, vulnerabilities, and weaknesses
66
seriously.
@@ -34,7 +34,7 @@ We will make our best effort to respond within a timely manner. Most
3434
vulnerabilities found within published code will undergo an embargo of
3535
90 days to allow time fixes to be developed and deployed.
3636

37-
## Vulnerability Advisories
37+
## Vulnerability advisories
3838

3939
Vulnerability reports and published fixes will be reported as follows:
4040

docs/SubmittingPatches.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Submitting Patches
1+
# Submitting patches
22

33
Development on MCUboot primarily takes place in github, at:
44
https://github.com/mcu-tools/mcuboot
@@ -27,7 +27,7 @@ space. JIRA is quite flexible about where the indicators go, but
2727
putting them in a trailer with a common format will make them easier
2828
to find later.
2929

30-
# Developer Certificate of Origin
30+
# Developer certificate of origin
3131

3232
```
3333
Developer Certificate of Origin

docs/design.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ characteristics:
4848
* Built to run from flash.
4949
* Built to run from a fixed location (i.e., not position-independent).
5050

51-
## [Image Format](#image-format)
51+
## [Image format](#image-format)
5252

5353
The following definitions describe the image format.
5454

@@ -134,7 +134,7 @@ The `ih_hdr_size` field indicates the length of the header, and therefore the
134134
offset of the image itself. This field provides for backwards compatibility in
135135
case of changes to the format of the image header.
136136

137-
## [Flash Map](#flash-map)
137+
## [Flash map](#flash-map)
138138

139139
A device's flash is partitioned according to its _flash map_. At a high
140140
level, the flash map maps numeric IDs to _flash areas_. A flash area is a
@@ -165,7 +165,7 @@ images therefore the flash area IDs of primary and secondary areas are mapped
165165
based on the number of the active image (on which the bootloader is currently
166166
working).
167167

168-
## [Image Slots](#image-slots)
168+
## [Image slots](#image-slots)
169169

170170
A portion of the flash memory can be partitioned into multiple image areas, each
171171
contains two image slots: a primary slot and a secondary slot.
@@ -251,7 +251,7 @@ work properly even when it is reset during the middle of an image swap. For this
251251
reason, the rest of the document describes its behavior when configured to swap
252252
images during an upgrade.
253253

254-
### [RAM Loading](#ram-load)
254+
### [RAM loading](#ram-load)
255255

256256
In ram-load mode the slots are equal. Like the direct-xip mode, this mode
257257
also selects the newest image by reading the image version numbers in the image
@@ -293,7 +293,7 @@ happens as described above. If the image is encrypted, it is copied in RAM at
293293
the provided address and then decrypted. Finally, the decrypted image is
294294
authenticated in RAM and executed.
295295
296-
## [Boot Swap Types](#boot-swap-types)
296+
## [Boot swap types](#boot-swap-types)
297297
298298
When the device first boots under normal circumstances, there is an up-to-date
299299
firmware image in each primary slot, which MCUboot can validate and then
@@ -375,7 +375,7 @@ direct-xip mode's "revert" mechanism are the following:
375375
- Proceed to step 3.
376376
3. Proceed to image validation ...
377377
378-
## [Image Trailer](#image-trailer)
378+
## [Image trailer](#image-trailer)
379379
380380
For the bootloader to be able to determine the current state and what actions
381381
should be taken during the current boot operation, it uses metadata stored in
@@ -490,7 +490,7 @@ of 3 is explained below.
490490
};
491491
```
492492

493-
## [IMAGE TRAILERS](#image-trailers)
493+
## [Image trailers](#image-trailers)
494494

495495
At startup, the bootloader determines the boot swap type by inspecting the
496496
image trailers. When using the term "image trailers" what is meant is the
@@ -585,7 +585,7 @@ occurred mid-swap), it fully determines the operation to resume by reading the
585585
0-3. The set of tables in the previous section are not necessary in the resume
586586
case.
587587

588-
## [High-Level Operation](#high-level-operation)
588+
## [High-level operation](#high-level-operation)
589589

590590
With the terms defined, we can now explore the bootloader's operation. First,
591591
a high-level overview of the boot process is presented. Then, the following
@@ -613,7 +613,7 @@ Procedure:
613613

614614
3. Boot into image in primary slot.
615615

616-
### [Multiple Image Boot](#multiple-image-boot)
616+
### [Multiple image boot](#multiple-image-boot)
617617

618618
When the flash contains multiple executable images the bootloader's operation
619619
is a bit more complex but similar to the previously described procedure with
@@ -705,7 +705,7 @@ process is presented below.
705705
+ Boot into image in the primary slot of the 0th image position\
706706
(other image in the boot chain is started by another image).
707707

708-
### [Multiple Image Boot for RAM loading and direct-xip](#multiple-image-boot-for-ram-loading-and-direct-xip)
708+
### [Multiple image boot for RAM loading and direct-xip](#multiple-image-boot-for-ram-loading-and-direct-xip)
709709

710710
The operation of the bootloader is different when the ram-load or the
711711
direct-xip strategy is chosen. The flash map is very similar to the swap
@@ -740,7 +740,7 @@ strategy but there is no need for Scratch area.
740740

741741
+ Boot the loaded slot of image 0.
742742

743-
## [Image Swapping](#image-swapping)
743+
## [Image swapping](#image-swapping)
744744

745745
The bootloader swaps the contents of the two image slots for two reasons:
746746

@@ -836,7 +836,7 @@ happened when a swap was requested:
836836
After completing the operations as described above the image in the primary slot
837837
should be booted.
838838

839-
## [Swap Status](#swap-status)
839+
## [Swap status](#swap-status)
840840

841841
The swap status region allows the bootloader to recover in case it restarts in
842842
the middle of an image swap operation. The swap status region consists of a
@@ -917,7 +917,7 @@ point within the region.
917917
Note: since the scratch area only ever needs to record swapping of the last
918918
sector, it uses at most min-write-size * 3 bytes for its own status area.
919919

920-
## [Reset Recovery](#reset-recovery)
920+
## [Reset recovery](#reset-recovery)
921921

922922
If the bootloader resets in the middle of a swap operation, the two images may
923923
be discontiguous in flash. Bootutil recovers from this condition by using the
@@ -986,7 +986,7 @@ belongs to image 0 or image 1.
986986
After the swap operation has been completed, the bootloader proceeds as though
987987
it had just been started.
988988

989-
## [Integrity Check](#integrity-check)
989+
## [Integrity check](#integrity-check)
990990

991991
An image is checked for integrity immediately before it gets copied into the
992992
primary slot. If the bootloader doesn't perform an image swap, then it can
@@ -1027,7 +1027,7 @@ If you want to enable and use encrypted images, see:
10271027
Note: Image encryption is not supported when the direct-xip upgrade strategy
10281028
is selected.
10291029

1030-
### [Using Hardware Keys for Verification](#hw-key-support)
1030+
### [Using hardware keys for verification](#hw-key-support)
10311031

10321032
By default, the whole public key is embedded in the bootloader code and its
10331033
hash is added to the image manifest as a KEYHASH TLV entry. As an alternative
@@ -1082,7 +1082,7 @@ D | +-----------------+ |
10821082
+---------------------+
10831083
```
10841084

1085-
## [Dependency Check](#dependency-check)
1085+
## [Dependency check](#dependency-check)
10861086

10871087
MCUboot can handle multiple firmware images. It is possible to update them
10881088
independently but in many cases it can be desired to be able to describe
@@ -1106,22 +1106,22 @@ state after dependency check.
11061106
For more information on adding dependency entries to an image,
11071107
see: [imgtool](imgtool.md).
11081108

1109-
## [Downgrade Prevention](#downgrade-prevention)
1109+
## [Downgrade prevention](#downgrade-prevention)
11101110

11111111
Downgrade prevention is a feature which enforces that the new image must have a
11121112
higher version/security counter number than the image it is replacing, thus
11131113
preventing the malicious downgrading of the device to an older and possibly
11141114
vulnerable version of its firmware.
11151115

1116-
### [SW Based Downgrade Prevention](#sw-downgrade-prevention)
1116+
### [Software-based downgrade prevention](#sw-downgrade-prevention)
11171117

11181118
During the software based downgrade prevention the image version numbers are
11191119
compared. This feature is enabled with the `MCUBOOT_DOWNGRADE_PREVENTION`
11201120
option. In this case downgrade prevention is only available when the
11211121
overwrite-based image update strategy is used (i.e. `MCUBOOT_OVERWRITE_ONLY`
11221122
is set).
11231123

1124-
### [HW Based Downgrade Prevention](#hw-downgrade-prevention)
1124+
### [Hardware-based downgrade prevention](#hw-downgrade-prevention)
11251125

11261126
Each signed image can contain a security counter in its protected TLV area, which
11271127
can be added to the image using the `-s` option of the [imgtool](imgtool.md) script.

docs/readme-espressif.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The current port is available for use in the following SoCs within the OSes:
1414
- Zephyr RTOS - _WIP_
1515
- NuttX - _WIP_
1616

17-
## Installing Requirements and Dependencies
17+
## Installing requirements and dependencies
1818

1919
1. Install additional packages required for development with MCUboot:
2020

docs/readme-riot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ or Zephyr, following the provided instructions.
1515
In the next version, it is planned to compile MCUboot using RIOT,
1616
which should be able to boot any of the supported OS images.
1717

18-
## Building Applications for the bootloader
18+
## Building applications for the bootloader
1919

2020
A compatible MCUboot image can be compiled by typing: `make mcuboot`.
2121

docs/readme-zephyr.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ flash partitions defined is the frdm_k64f's in
3030
`boards/arm/frdm_k64f/frdm_k64f.dts`. Make sure the labels in your board's
3131
`.dts` file match the ones used there.
3232

33-
## Installing Requirements and Dependencies
33+
## Installing requirements and dependencies
3434

3535
Install additional packages required for development with MCUboot:
3636

@@ -74,7 +74,7 @@ on the target and flash tool used, this might erase the whole of the flash
7474
memory (mass erase) or only the sectors where the bootloader resides prior to
7575
programming the bootloader image itself.
7676

77-
## Building Applications for the bootloader
77+
## Building applications for the bootloader
7878

7979
In addition to flash partitions in DTS, some additional configuration
8080
is required to build applications for MCUboot.

docs/release-notes.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# MCUboot Release Notes
1+
# MCUboot release notes
22

33
- Table of Contents
44
{:toc}
@@ -75,7 +75,7 @@ There are bug fixes, and associated imgtool updates as well.
7575
- imgtool: added possibility to set confirm flag for hex files as well.
7676
- imgtool: Print image digest during verify.
7777

78-
### Zephyr-RTOS Compatibility
78+
### Zephyr-RTOS compatibility
7979

8080
This release of MCUboot works with the Zephyr "main" at the time of the
8181
release. It was tested as of has 7a3b253ce. This version of MCUboot also
@@ -111,7 +111,7 @@ updates as well.
111111
2.9.10 has an infinite loop in a certain end-of-file situation." Fix
112112
by updating a dependency in documentation generation.
113113

114-
### Zephyr-RTOS Compatibility
114+
### Zephyr-RTOS compatibility
115115

116116
This release of MCUboot works the Zephyr "main" at the time of the
117117
release. It was tested as of has 1a89ca1238. When Zephyr v2.3.0 is

docs/release.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Release Process
1+
# Release process
22

33
The following documents the release process used with MCUboot.
44

@@ -18,13 +18,13 @@ We add pre-release tags of the format MAJOR.MINOR.PATCH-rc1.
1818
We mark in documentation an MCUboot development version using
1919
the format MAJOR.MINOR.PATCH-dev.
2020

21-
## Release Notes
21+
## Release notes
2222

2323
Before making a release, be sure to update the `docs/release-notes.md`
2424
to describe the release. This should be a high-level description of
2525
the changes, not a list of the git commits.
2626

27-
## Release Candidates
27+
## Release candidates
2828

2929
Prior to each release, tags are made (see below) for at least one
3030
release candidate (a.b.c-rc1, followed by a.b.c-rc2, etc, followed by
@@ -35,7 +35,7 @@ During the time between rc1 and the final release, the only changes
3535
that should be merged into main are those to fix bugs found in the
3636
rc and Mynewt metadata as described in the next section.
3737

38-
## imgtool release
38+
## Imgtool release
3939

4040
imgtool is released through pypi.org (The Python package index) and
4141
requires that its version to be updated by editing
@@ -57,7 +57,7 @@ the rc step is finished, the release needs to be exported by modifying
5757
new release version, including updates to the pseudo keys
5858
(`*-(latest|dev)`).
5959

60-
## Tagging and Release
60+
## Tagging and release
6161

6262
To make a release, make sure your local repo is on the tip version by
6363
fetching from origin. Typically, the releaser should create a branch
@@ -85,7 +85,7 @@ git push origin HEAD:refs/heads/main
8585
git push origin va.b.c-rcn
8686
```
8787

88-
## Branching after a Release
88+
## Branching after a release
8989

9090
After the final (non-`rc`) a.b.0 release is made, a new branch must
9191
be created and pushed:

docs/signed_images.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ This exports the keys.
9191

9292
const int bootutil_key_cnt = sizeof(bootutil_keys) / sizeof(bootutil_keys[0]);
9393

94-
## Building bootloader
94+
## Building the bootloader
9595

9696
Enable the BOOTUTIL_SIGN_RSA syscfg setting in your app or target syscfg.yml
9797
file

docs/testplan-mynewt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## mcuboot test plan
1+
## MCUboot test plan
22

33
The current target for running the tests is the Freedom K64F board.
44

docs/testplan-zephyr.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Zephyr Test Plan
1+
# Zephyr test plan
22

33
The following roughly describes how MCUboot is tested on Zephyr. The
44
testing is done with the code in `samples/zephyr`. These examples

0 commit comments

Comments
 (0)