summaryrefslogtreecommitdiffstats
path: root/Documentation/user/variables.rst
diff options
context:
space:
mode:
authorRoland Hieber <r.hieber@pengutronix.de>2018-08-10 00:22:59 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2018-08-10 08:41:09 +0200
commit68de5efb38fd2f38fa3f59c26fd07fa3b1180186 (patch)
treef56b1edb85b159f785c35c06ad113d2dacb29d56 /Documentation/user/variables.rst
parentc3b5e27c5d1f1049b400339b721eff20e0e1243a (diff)
downloadbarebox-68de5efb38fd2f38fa3f59c26fd07fa3b1180186.tar.gz
barebox-68de5efb38fd2f38fa3f59c26fd07fa3b1180186.tar.xz
Documentation: fix code block and literal block highlighting
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>
Diffstat (limited to 'Documentation/user/variables.rst')
-rw-r--r--Documentation/user/variables.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/user/variables.rst b/Documentation/user/variables.rst
index e0a79416c6..ddfd485740 100644
--- a/Documentation/user/variables.rst
+++ b/Documentation/user/variables.rst
@@ -12,12 +12,16 @@ The ``global`` device
The ``global`` device is a special purpose device. It only exists as a
storage for global variables. Some global variables are created internally
in barebox (see :ref:`magicvars`). Additional variables can be created with
-the :ref:`command_global` command::
+the :ref:`command_global` command:
+
+.. code-block:: sh
global myvar
This creates the ``global.myvar`` variable which now can be used like any
-other variable. You can also directly assign a value during creation::
+other variable. You can also directly assign a value during creation:
+
+.. code-block:: sh
global myvar1=foobar
@@ -48,7 +52,7 @@ actual values.
examples:
-.. code-block:: sh
+.. code-block:: console
barebox@Phytec phyCARD-i.MX27:/ devinfo nv
barebox@Phytec phyCARD-i.MX27:/ nv model=myboard
@@ -94,7 +98,9 @@ Some variables have special meanings and influence the behaviour
of barebox. Most but not all of them are consolidated in the :ref:`global_device`.
Since it's hard to remember which variables these are and if the current
barebox has support for them the :ref:`command_magicvar` command can print a list
-of all variables with special meaning along with a short description::
+of all variables with special meaning along with a short description:
+
+.. code-block:: console
barebox:/ magicvar
OPTARG optarg for hush builtin getopt