summaryrefslogtreecommitdiffstats
path: root/Documentation/user/variables.rst
Commit message (Collapse)AuthorAgeFilesLines
* doc: variables: nv vars are saved automatically.Tomaz Solc2019-04-231-3/+5
| | | | | | | | | | In recent barebox versions, nv variables are saved automatically upon reset or kernel start (console message "nv variable modified, will save nv variables on shutdown" warns about that). There is no need to explicitly call saveenv. This change was introduced in 3fadbdae. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: fix code block and literal block highlightingRoland Hieber2018-08-101-4/+10
| | | | | | | | | Use shell script highlighting where it is resonable, use console highlighting for transcripts, and fix some of the few cases where the syntax was broken, resulting in text not being rendered at all. Signed-off-by: Roland Hieber <r.hieber@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: variables: fix error in "code-block" directiveAntony Pavlov2016-08-151-0/+1
| | | | | | | | | | | | | | | | | | The patch fixes this sphinx error: barebox/Documentation/user/variables.rst:79: ERROR: Error in "code-block" directive: maximum 1 argument(s) allowed, 15 supplied. .. code-block:: sh barebox@Phytec phyCARD-i.MX27:/ nv dev.nand0.partitions: 4M(barebox),1M(barebox-environment),-(root) barebox@Phytec phyCARD-i.MX27:/ devinfo nand0 Parameters: [...] partitions: 4M(barebox),1M(barebox-environment),8M(kernel),1011M(root) [...] Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Introduce non volatile device variablesSascha Hauer2016-07-061-0/+18
| | | | | | | | | | | | | | Non volatile device variables are used to make device parameters persistent. They are like normal non volatile variables, but set the values of the device parameters with the corresponding name. Every nv variable beginning with nv.dev is a non volatile device variable. They have the form nv.dev.<devname>.<paramname> and act on the parameter <paramname> of the device named <devname>. The non volatile device variables are designated for example for video modes, ethernet device ip addresses or mtd partitioning. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Fix spelling: pathes -> pathsWadim Egorov2015-01-281-1/+1
| | | | | Signed-off-by: Wadim Egorov <w.egorov@phytec.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* docs: fix broken referenceLucas Stach2015-01-191-2/+2
| | | | | Signed-off-by: Lucas Stach <dev@lynxeye.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Add support for non volatile variablesSascha Hauer2014-11-061-0/+41
| | | | | | | | | | | | | | | This adds (back) support for non volatile variables. Non volatile variables are variables which are stored in the environment over reboot. They are used in the same way as the global variables, but with a 'nv' command and device. The variables are stored under /env/nv/, one variable per file. Adding a nv variable automatically adds a global variable with the same name. Changing a nv variable also changes the same global variable, but not the other way round. This allows for example to configure the username as: nv user=sha; saveenv Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Numerous typoes/fixes in first few chapters of user manual.Robert P. J. Day2014-07-031-1/+1
| | | | | | | | | | | | Doc fixes such as: * font changes * spelling * punctuation * capitalization Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: link back from variables to device parametersHolger Schurig2014-06-271-2/+5
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: remove board type from barebox prompt examplesHolger Schurig2014-06-271-1/+1
| | | | | | | I kept however the one example that directly demos the bootup on an Efika board. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* doc: add colon after NOTE and HINTHolger Schurig2014-06-271-1/+1
| | | | | Signed-off-by: Holger Schurig <holgerschurig@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
* Documentation: Add new sphinxs docsSascha Hauer2014-06-261-0/+49
This is a rewrite of the Documentation in reStructuredText format using Sphinx as build system, see http://sphinx-doc.org/. The documentation is built into static html pages with 'make docs'. The pages can be found under Documentation/html after building. Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>