mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: "Uwe Kleine-König" <u.kleine-koenig@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH v2 1/3] Documentation: state: adapt description to reality
Date: Thu, 28 Sep 2017 11:03:27 +0200	[thread overview]
Message-ID: <20170928090329.28006-2-u.kleine-koenig@pengutronix.de> (raw)
In-Reply-To: <20170928090329.28006-1-u.kleine-koenig@pengutronix.de>

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
 .../devicetree/bindings/barebox/barebox,state.rst      | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/Documentation/devicetree/bindings/barebox/barebox,state.rst b/Documentation/devicetree/bindings/barebox/barebox,state.rst
index 40d7bc2e6fdf..ed17e3e75883 100644
--- a/Documentation/devicetree/bindings/barebox/barebox,state.rst
+++ b/Documentation/devicetree/bindings/barebox/barebox,state.rst
@@ -127,14 +127,16 @@ Variable Types
 Backends
 --------
 
-Currently two backends exist. The raw backend is a very compact format
-consisting of a magic value for identification, the raw values and a
-CRC. Two copies are maintained for making sure that during update the
-storage device still contains a valid state. The dtb backend stores
-the state as a devicetree binary blob. This is exactly the original
-devicetree description of the state itself, but additionally contains
-the actual values of the variables. Unlike the raw state backend the
-dtb state backend can describe itself.
+Currently two backends exist. The ``raw`` backend is a very compact format
+consisting of a magic value for identification, a crc-protected header giving
+the actual length and then the raw values and another CRC. To make sure that
+during update the storage device always contains a valid state, the data is
+replicated on the medium.
+
+The ``dtb`` backend stores the state as a devicetree binary blob.  This is
+exactly the original devicetree description of the state itself, but
+additionally contains the actual values of the variables. Unlike the ``raw``
+state backend the ``dtb`` state backend can describe itself.
 
 HMAC
 ----
-- 
2.11.0


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

  reply	other threads:[~2017-09-28  9:04 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-28  9:03 [PATCH v2 0/3] state: add support for pre-mainline state format Uwe Kleine-König
2017-09-28  9:03 ` Uwe Kleine-König [this message]
2017-09-28 10:53   ` [PATCH v2 1/3] Documentation: state: adapt description to reality Sascha Hauer
2017-09-28  9:03 ` [PATCH v2 2/3] state: new backend format "rawcompat" Uwe Kleine-König
2017-09-28  9:03 ` [PATCH v2 3/3] state: storage: direct: skip writing meta data if this makes data fit Uwe Kleine-König

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=20170928090329.28006-2-u.kleine-koenig@pengutronix.de \
    --to=u.kleine-koenig@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