zephyr/samples/subsys/fs
Ulf Magnusson eba81c6e54 yaml: Remove redundant document separators
YAML document separators are needed e.g. when doing

  $ cat doc1.yaml doc2.yaml | <parser>

For the bindings, we never parse concatenated documents. Assume we don't
for any other .yaml files either.

Having document separators in e.g. base.yaml makes !include a bit
confusing, since the !included files are merged and not separate
documents (the merging is done in Python code though, so it makes no
difference for behavior).

The replacement was done with

    $ git ls-files '*.yaml' | \
        xargs sed -i -e '${/\s*\.\.\.\s*/d;}' -e 's/^\s*---\s*$//'

First pattern removes ... at the end of files, second pattern clears a
line with a lone --- on it.

Some redundant blank lines at the end of files were cleared with

    $ git ls-files '*.yaml' | xargs sed -i '${/^\s*$/d}'

This is more about making sure people can understand why every part of a
binding is there than about removing some text.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-06-19 10:40:10 +02:00
..
src samples: fs: Fix possible integer overflow 2019-03-02 17:38:23 +01:00
CMakeLists.txt license: cleanup: add SPDX Apache-2.0 license identifier 2019-04-07 08:45:22 -04:00
nrf52840_blip.overlay dts: Replace status = "ok" with status = "okay" 2019-06-14 19:51:13 -05:00
prj.conf
README.rst
sample.yaml yaml: Remove redundant document separators 2019-06-19 10:40:10 +02:00

.. _fat_fs:

FAT Filesystem Sample Application
###################################

Overview
********

This sample app demonstrates use of the filesystem API and uses the FAT file
system driver to mount an SDHC card connected over SPI bus.

Requirements
************

This project requires a SDHC or microSD card formatted with FAT filesystem.
See the :ref:`SDHC_disks` documentation for Zephyr implementation details.

Building and Running
********************

This sample can be built for an ``nrf52840_blip`` board. It requires
both the ``nrf52840_blip.overlay`` and the ``dts_fixup.h`` for nrf52840_blip
to work:

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/fs
   :board: nrf52840_blip
   :goals: build
   :compact:

To run this sample, a FAT formatted microSD card should be present in the
microSD slot of ``nrf52840_blip`` board. If there are any files or directories
present in the card, the sample lists them out on the debug serial output.