Skip to content

Commit a6a0e0e

Browse files
mbolivar-nordicutzig
authored andcommitted
doc: clean up multi-image documentation
Some design.md content is causing build errors when they are included in a .rst based documentation tree in Sphinx. Adjust the format to make it work in both systems. Signed-off-by: Martí Bolívar <[email protected]>
1 parent a2fad12 commit a6a0e0e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/design.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ following section. The multiple image boot procedure is organized in loops which
606606
iterate over all the firmware images. The high-level overview of the boot
607607
process is presented below.
608608
609-
+ ###### Loop 1. Iterate over all images
609+
+ Loop 1. Iterate over all images
610610
1. Inspect swap status region of current image; is an interrupted swap being
611611
resumed?
612612
+ Yes:
@@ -634,7 +634,7 @@ process is presented below.
634634
+ Mark the swap type as `None`.
635635
+ Skip to next image.
636636
637-
+ ###### Loop 2. Iterate over all images
637+
+ Loop 2. Iterate over all images
638638
1. Does the current image depend on other image(s)?
639639
+ Yes: Are all the image dependencies satisfied?
640640
+ Yes: Skip to next image.
@@ -643,15 +643,15 @@ process is presented below.
643643
+ Restart dependency check from the first image.
644644
+ No: Skip to next image.
645645
646-
+ ###### Loop 3. Iterate over all images
646+
+ Loop 3. Iterate over all images
647647
1. Is an image swap requested?
648648
+ Yes:
649649
+ Perform image update operation.
650650
+ Persist completion of swap procedure to image trailers.
651651
+ Skip to next image.
652652
+ No: Skip to next image.
653653
654-
+ ###### Loop 4. Iterate over all images
654+
+ Loop 4. Iterate over all images
655655
1. Validate image in the primary slot (integrity and security check) or
656656
at least do a basic sanity check to avoid booting into an empty flash
657657
area.

0 commit comments

Comments
 (0)