summaryrefslogtreecommitdiffstats
path: root/Documentation/user/state.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc: user: state: document backend references using GPT/MBR partitionsRoland Hieber2023-08-091-22/+88
| | | | | | | | | | | | | Explain first how to define the state node and variable set, and then go into detail about the different variations of backend definitions, including the options of referring to a backend partition by its partuuid or letting barebox auto-detect it by its Type GUID. Fixes: 776714d9570253c46635 (2023-06-07, "state: allow lookup of barebox state partition by Type GUID") Suggested-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230808092617.2037996-4-rhi@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: user: state: update note about redefining existing partitionsRoland Hieber2023-08-091-4/+9
| | | | | | | | Fixes: ec34c2f5333adfee4724 (2023-06-07, "cdev: have devfs_add_partition return existing identical partition, not NULL") Suggested-by: Ahmad Fatoum <a.fatoum@pengutronix.de> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230808092617.2037996-3-rhi@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* treewide: drop trailing spaceAhmad Fatoum2023-05-021-1/+1
| | | | | | | | | | | | | | Found by manual inspection of the output of: rg '\s+$' | rg -v dts/ Patch can be verified by observing that no diff results from: git show --ignore-space-at-eol Signed-off-by: Ahmad Fatoum <ahmad@a3f.at> Link: https://lore.barebox.org/20230424121805.150434-4-ahmad@a3f.at Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: recommend a partition type GUID for state GPT partitionsBastian Krause2021-02-161-0/+3
| | | | | | | | | | | | | | | The partition type GUID was generated randomly. Having a defined GUID should reduce the risk of collisions in the future. A dedicated GUID could also allow us to implement a fallback in case no state backend property is defined. This could then look for a GPT partition with this partition type GUID and use that as the backend. dt-utils could do the same in userspace. This would be similar to [1]. [1] https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/ Signed-off-by: Bastian Krause <bst@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: clarify how to access state device parametersAhmad Fatoum2020-11-131-3/+3
| | | | | | | | | | | | 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>
* doc: clarify state framework driver requirementMoritz Augsburger2019-04-261-1/+7
|
* Documentation: state: fix closing brace without opening braceRoland Hieber2019-01-211-1/+0
| | | | | | | | | Also fix the resulting sphinx warning: Documentation/user/state.rst:650: WARNING: Explicit markup ends without a blank line; unexpected unindent. Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: add unit name to state variable in DTUlrich Ölmann2018-07-131-5/+5
| | | | | | | | | | | | | Starting with DT compiler version 1.4.6 (included since v2018.07.0) one gets warnings <node>: node has a reg or ranges property, but no unit name if the first address field of a reg-property is not taken as the unit name for its parent node. Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: fix typosUlrich Ölmann2018-07-131-31/+31
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: harmonize capitalization in headingsUlrich Ölmann2018-07-131-7/+7
| | | | | Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: state: mention SD/eMMC devicesSascha Hauer2017-12-111-2/+44
| | | | | | | The state framework also has support for SD/eMMC devices, so mention them in the documentation. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: rework and extend the 'state' and 'bootchooser' documentationJuergen Borleis2017-09-061-59/+637
| | | | | | | | Many links between sections and examples were added to give the developer the help to get it work. Signed-off-by: Juergen Borleis <jbe@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* state: Update documentationSascha Hauer2017-03-311-7/+26
| | | | | | | | - explain what buckets are - rework text about storage backends - explain redundancy concept Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* boot: add framework for redundant boot scenariosMarc Kleine-Budde2016-09-221-0/+2
| | | | | | | | | | | | | | | There are several use cases where a redundant Linux system is needed. The barebox bootchooser framework provides the building blocks to model different use cases without the need to start from the scratch over and over again. The bootchooser works on abstract boot targets, each with a set of properties and implements an algorithm which selects the highest priority target to boot. See the documentation contained in this patch for more information. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: Add/Update state documentationMarkus Pargmann2016-07-081-0/+46
Signed-off-by: Markus Pargmann <mpa@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-19 10:41:04 +0000