[PATCH v2 1/3] Documentation: state: adapt description to reality

Uwe Kleine-König u.kleine-koenig at pengutronix.de
Thu Sep 28 02:03:27 PDT 2017


Signed-off-by: Uwe Kleine-König <u.kleine-koenig at 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




More information about the barebox mailing list