summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorMoritz Augsburger <moritz@augsburger.name>2019-04-23 21:56:08 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2019-04-26 08:11:17 +0200
commit17ab16933959bf8722c6cb353f31fc06926e2ad4 (patch)
tree64228a2057327aa094fd56859e9cc20feaff0afd /Documentation
parent6fcf89d932676951dac05c9c92fcdd54b0ab84a9 (diff)
downloadbarebox-17ab16933959bf8722c6cb353f31fc06926e2ad4.tar.gz
doc: clarify state framework driver requirement
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/user/state.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Documentation/user/state.rst b/Documentation/user/state.rst
index 07743df..78ce24f 100644
--- a/Documentation/user/state.rst
+++ b/Documentation/user/state.rst
@@ -21,7 +21,13 @@ RAUC_.
.. _RAUC: https://rauc.readthedocs.io/en/latest/
barebox itself uses a *state* driver to access the variables in the
-persistent memory. For the Linux run-time there is a userspace tool_ to do
+persistent memory.
+
+Currently there is only one implementation, enabled by
+``CONFIG_STATE_DRV=y``. Without driver, the state framework will silently
+fail and be non-functional.
+
+For the Linux run-time there is a userspace tool_ to do
the same.
.. _tool: https://git.pengutronix.de/cgit/tools/dt-utils/