sysmo-bts
/
barebox
9
0
Fork 0
Code Releases Activity

Documentation: Clean up sandbox.rst, use definition list. 

Some minor cleanup to the sandbox.rst documentation file, mostly
involving using a definition list for the options.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
This commit is contained in:
Robert P. J. Day 2014-06-28 10:13:55 -04:00 committed by Sascha Hauer
parent 0bee49e72c
commit d12f62829e
1 changed files with 27 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
Documentation/boards/sandbox.rst
View File

@ -4,64 +4,52 @@ Sandbox
barebox can be run as a simulator on your host to check and debug new non
hardware related features.
Build barebox for simulation
----------------------------
Building barebox for simulation
-------------------------------
the barebox sand box can be built with the host compiler::
The barebox sandbox can be built with the host compiler::
ARCH=sandbox make sandbox_defconfig
ARCH=sandbox make
Run sandbox
-----------
Running the sandbox
-------------------
::
Once you compile barebox for the sandbox, you can run it with::
$ barebox [\<OPTIONS\>]
$ barebox [<OPTIONS>]
Options can be::
Available sandbox invocation options include:
-m, --malloc=\<size\>
``-m``, ``--malloc=<size>``
Start sandbox with a specified malloc-space \<size\> in bytes.
Start sandbox with a specified malloc-space <size> in bytes.
::
``-i <file>``
-i \<file\>
Map a <file> to barebox. This option can be given multiple times. The <file>s
will show up as ``/dev/fd0`` ... ``/dev/fdX`` in the barebox simulator.
Map a \<file\> to barebox. This option can be given multiple times. The \<file\>s
will show up as /dev/fd0 ... /dev/fdx in the barebox simulator.
``-e <file>``
::
Map <file> to barebox. With this option <file>s are mapped as
``/dev/env0`` ... ``/dev/envX`` and thus are used as default environment.
A clean file generated with ``dd`` will do to get started with an empty environment.
-e \<file\>
``-O <file>``
Map \<file\> to barebox. With this option \<file\>s are mapped as /dev/env0 ...
/dev/envx and thus are used as default environment. A clean file generated
with dd will do to get started with an empty environment
Register <file> as a console capable of doing stdout. <file> can be a
regular file or a FIFO.
::
``-I <file>``
-O \<file\>
Register <file> as a console capable of doing stdin. <file> can be a regular
file or a FIFO.
Register \<file\> as a console capable of doing stdout. \<file\> can be a
regular file or a fifo.
``-x``, ``--xres <res>``
::
Specify SDL width.
-I \<file\>
``-y``, ``--yres <res>``
Register \<file\> as a console capable of doing stdin. \<file\> can be a regular
file or a fifo.
::
-x, --xres \<res\>
Specify SDL width
::
-y, --yres \<res\>
Specify SDL height
Specify SDL height.