diff options
author | Ahmad Fatoum <a.fatoum@pengutronix.de> | 2020-11-10 16:34:30 +0100 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2020-11-13 08:53:40 +0100 |
commit | eb95f99a0aeef53c5c31883cecef47b8c8c79130 (patch) | |
tree | 48a6665d81736af3987e789b82a6057b841d178c /Documentation/user | |
parent | 4fd3686373e842ac3e43b53ca5280b38e5a3d96b (diff) | |
download | barebox-eb95f99a0aeef53c5c31883cecef47b8c8c79130.tar.gz barebox-eb95f99a0aeef53c5c31883cecef47b8c8c79130.tar.xz |
Documentation: state: clarify how to access state device parameters
Users may be inclined to use hyphens in state variable names as this is
customary for device tree nodes. Such variables can't be read with
$state.example-variable or written with state.example-variable=,
because it's incompatible with Hush. Adjust the documentation to nudge
users into the correct direction (${state.example-variabe} and setenv)
Suggested-by: Matthias Fend <Matthias.Fend@wolfvision.net>
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/user')
-rw-r--r-- | Documentation/user/state.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/user/state.rst b/Documentation/user/state.rst index 78ce24f9ed..54aa396257 100644 --- a/Documentation/user/state.rst +++ b/Documentation/user/state.rst @@ -684,9 +684,9 @@ Frontend -------- As frontend a *state* instance is a regular barebox device which has -device parameters for the *state* variables. With this the variables can +:ref:`device_parameters` for the *state* variables. With this the variables can be accessed like normal shell variables. The ``state`` command is used to save/restore a *state* variable set to the backend device. -After initializing the variable can be accessed with ``$state.foo``. -``state -s`` stores the *state* to the backend device. +After initializing the variable can be accessed with ``${state.foo}`` or +:ref:`command_setenv`. ``state -s`` stores the *state* to the backend device. |