Skip to content

Commit d776ca5

Browse files
pfeerickearlephilhower
authored andcommitted
Re-wording of ATOMIC_FS_UPDATE documenation (#6693)
1 parent 70e8c99 commit d776ca5

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/ota_updates/readme.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ Update process - memory view
646646
- the new sketch is now copied "over" the old one.
647647
- the new sketch is started.
648648

649-
By default, filesystem updates are overriding the target flash directly. In order to use the same two step process set the `ATOMIC_FS_UPDATE` flag.
649+
By default, OTA filesystem updates overwrite the target flash directly. This can lead to the file system being corrupted if there is a power outage during the update process. In order to use the same two step process that is used for OTA application firmware updates, set the `ATOMIC_FS_UPDATE` flag. Note that you will need to have enough unused space for the new filesystem image to be stored, hence is why this is not the default behaviour.
650650

651651
.. figure:: update_memory_copy.png
652652
:alt: Memory layout for OTA updates

0 commit comments

Comments
 (0)