Skip to content

Commit 42fc9cd

Browse files
diegoherranznordicjm
authored andcommitted
docs/design: add notes about swap algorithms
- Indicate that swap-using-offset is preferred over swap-using-move. Reference: #2162 (comment) - Indicate that swap-using-scratch may be removed in the coming future. Reference: #2162 (comment) Signed-off-by: Diego Herranz <[email protected]>
1 parent 10a3cff commit 42fc9cd

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/design.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,9 @@ one of these two strategies.
183183

184184
### [Swap using scratch](#image-swap-using-scratch)
185185

186+
Please note that the swap-using-scratch algorithm may be removed in the coming
187+
future.
188+
186189
When swap-using-scratch algorithm is used, in addition to the slots of
187190
image areas, the bootloader requires a scratch area to allow for reliable
188191
image swapping. The scratch area must have a size
@@ -280,6 +283,9 @@ The algorithm is enabled using the `MCUBOOT_SWAP_USING_OFFSET` option.
280283

281284
### [Swap using move (without using scratch)](#image-swap-no-scratch)
282285

286+
Please note that the swap-using-offset algorithm is preferred over swap-using-move
287+
except when building for existing products already using the latter.
288+
283289
This algorithm is an alternative to the swap-using-scratch algorithm.
284290
It uses an additional sector in the primary slot to make swap possible.
285291
The algorithm works as follows:

0 commit comments

Comments
 (0)