From: "Ulrich Ölmann" <u.oelmann@pengutronix.de>
To: Barebox List <barebox@lists.infradead.org>
Subject: [PATCH 1/3] Documentation: state: harmonize capitalization in headings
Date: Tue, 10 Jul 2018 11:50:01 +0200 [thread overview]
Message-ID: <20180710095003.1256-1-u.oelmann@pengutronix.de> (raw)
Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de>
---
Documentation/user/state.rst | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/user/state.rst b/Documentation/user/state.rst
index d17f39befbe4..97e45d43b7cb 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,
--
2.18.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next reply other threads:[~2018-07-10 9:50 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-07-10 9:50 Ulrich Ölmann [this message]
2018-07-10 9:50 ` [PATCH 2/3] Documentation: state: fix typos Ulrich Ölmann
2018-07-10 10:35 ` Roland Hieber
2018-07-10 9:50 ` [PATCH 3/3] Documentation: state: add unit name to state variable in DT Ulrich Ölmann
2018-07-10 10:36 ` Roland Hieber
2018-07-13 6:19 ` [PATCH 1/3] Documentation: state: harmonize capitalization in headings Sascha Hauer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180710095003.1256-1-u.oelmann@pengutronix.de \
--to=u.oelmann@pengutronix.de \
--cc=barebox@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox