summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorUlrich Ölmann <u.oelmann@pengutronix.de>2018-07-10 11:50:01 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2018-07-13 08:17:22 +0200
commit5d0077f2787520cb21a8cda72b764d0a0519d570 (patch)
treec1f27efb1047e93a2483955532c9050786745047
parent7257e80f5c052467333d800f2951c9338400111a (diff)
downloadbarebox-5d0077f2787520cb21a8cda72b764d0a0519d570.tar.gz
Documentation: state: harmonize capitalization in headings
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
-rw-r--r--Documentation/user/state.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Documentation/user/state.rst b/Documentation/user/state.rst
index d17f39b..97e45d4 100644
--- a/Documentation/user/state.rst
+++ b/Documentation/user/state.rst
@@ -52,7 +52,7 @@ required to define the location where to store the *state* variable set.
.. _state_framework,backend_types:
-Backend-Types (e.g. *state* storage format)
+Backend-Types (e.g. *state* Storage Format)
-------------------------------------------
The *state* variable set itself can be stored in different ways. Currently two
@@ -66,7 +66,7 @@ Both serialize the *state* variable set differently.
.. _state_framework,raw:
-The ``raw`` *state* storage format
+The ``raw`` *state* Storage Format
##################################
``raw`` means the *state* variable set is a simple binary data blob only. In
@@ -117,7 +117,7 @@ embedded *state* variable set. Refer to
.. _state_framework,dtb:
-The ``dtb`` *state* storage format
+The ``dtb`` *state* Storage Format
##################################
.. note:: The ``dtb`` backend type isn't well tested. Use the ``raw`` backend
@@ -130,7 +130,7 @@ Unlike the ``raw`` *state* backend the ``dtb`` *state* backend can describe itse
.. _state_framework,backend_storage_type:
-Backend Storage Types (e.g. media storage layout)
+Backend Storage Types (e.g. Media Storage Layout)
-------------------------------------------------
The serialized data (``raw`` or ``dtb``) can be stored to different backend
@@ -321,7 +321,7 @@ the eraseblock again. This significantly reduces the need for a block erases.
.. important:: One copy of the *state* variable set is limited to the page size
of the used backend (e.g. NAND type flash memory)
-Redundant *state* variable set copies
+Redundant *state* Variable Set Copies
-------------------------------------
To avoid data loss when changing the *state* variable set, more than one
@@ -431,7 +431,7 @@ variable set has a size of 17 bytes (16 bytes header plus one byte variables).
.. note:: For a more detailed description of the used *state* variable set
properties here, refer to :ref:`barebox,state`.
-NOR flash memories
+NOR Flash Memories
##################
This type of memory can be written on a single byte/word basis (depending on its bus
@@ -482,7 +482,7 @@ content, its backend-type and *state* variable set layout.
};
};
-NAND flash memories
+NAND Flash Memories
###################
This type of memory can be written on a *page* base (typically 512 bytes,