diff --git a/samples/subsys/fs/format/README.md b/samples/subsys/fs/format/README.md deleted file mode 100644 index 162eee79a8a..00000000000 --- a/samples/subsys/fs/format/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# Format Sample Application - -## Overview -The aim of this sample application is to show how to format different storage -devices for different file systems. There are 2 scenarios prepared for this -sample: -* littleFS on flash device -* FAT file system on RAM disk - -## Building and running -To run this demo, build it for the desired board and flash it. -To build demo that will use RAM disk use `prj_ram.conf` configuration file (e.g. -by setting `CONF_FILE=prj_ram.conf`). - -The demo was build for 2 boards: -1. nRF 52DK with flash - ``` - west build -b nrf52dk_nrf52832 samples/subsys/fs/format - west flash - ``` - -2. MIMXRT1064-EVK with RAM disk - ``` - CONF_FILE=prj_ram.conf west build -b mimxrt1064_evk samples/subsys/fs/format - west flash - ``` - -When sample runs successfully you should see following message on the screen: -``` -I: LittleFS version 2.4, disk version 2.0 -I: FS at flash-controller@4001e000:0x7a000 is 6 0x1000-byte blocks with 512 cycle -I: sizes: rd 16 ; pr 16 ; ca 64 ; la 32 -I: Format successful -``` diff --git a/samples/subsys/fs/format/README.rst b/samples/subsys/fs/format/README.rst new file mode 100644 index 00000000000..f42209fc2f2 --- /dev/null +++ b/samples/subsys/fs/format/README.rst @@ -0,0 +1,50 @@ +.. _fs_format_sample: + +FS Format Sample +################ + +Overview +*********** + +This sample shows how to format different storage +devices for different file systems. There are 2 scenarios prepared for this +sample: +* littleFS on flash device +* FAT file system on RAM disk + +Building and running +******************** + +To run this sample, build it for the desired board and scenario and flash it. + +The Flash scenario is supported on the nrf52dk_nrf52832 board. +The RAM disk scenario is supported on the mimxrt1064_evk board. +To build the RAM disk sample, the configuration `prj_ram.conf` needs to be used by setting `CONF_FILE=prj_ram.conf`. + +The Flash sample for the nrf 52DK board can be build as follow: + +.. zephyr-app-commands:: + :zephyr-app: samples/subsys/fs/format + :board: nrf52dk_nrf52832 + :goals: build flash + :compact: + +The RAM disk sample for the MIMXRT1064-EVK board can be build as follow: + +.. zephyr-app-commands:: + :zephyr-app: samples/subsys/fs/format + :board: mimxrt1064_evk + :conf: "prj_ram.conf" + :goals: build flash + :compact: + +Sample Output +============= + +When the sample runs successfully you should see following message on the screen: +.. code-block:: console + + I: LittleFS version 2.4, disk version 2.0 + I: FS at flash-controller@4001e000:0x7a000 is 6 0x1000-byte blocks with 512 cycle + I: sizes: rd 16 ; pr 16 ; ca 64 ; la 32 + I: Format successful