[PATCH] Documentation: Clean up sandbox.rst, use definition list.

[PATCH] Documentation: Clean up sandbox.rst, use definition list.

[Robert P. J. Day]

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>

---

  i thought using a definition list here made the output cleaner, but
i'm willing to be convinced otherwise. also, all those backslashes
seemed unnecessary.

diff --git a/Documentation/boards/sandbox.rst b/Documentation/boards/sandbox.rst
index 4601aed..558f111 100644
--- a/Documentation/boards/sandbox.rst
+++ b/Documentation/boards/sandbox.rst
@@ -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.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: [PATCH] Documentation: Clean up sandbox.rst, use definition list.

[Sascha Hauer]

On Sat, Jun 28, 2014 at 10:13:55AM -0400, Robert P. J. Day wrote:
> 
> 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>

Applied, thanks

Sascha


-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox