From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: [PATCH] Documentation: Clean up sandbox.rst, use definition list.
Date: Sat, 28 Jun 2014 10:13:55 -0400 (EDT) [thread overview]
Message-ID: <alpine.LFD.2.11.1406281011120.4521@localhost> (raw)
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
next reply other threads:[~2014-06-28 14:18 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-06-28 14:13 Robert P. J. Day [this message]
2014-06-30 6:09 ` Sascha Hauer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.LFD.2.11.1406281011120.4521@localhost \
--to=rpjday@crashcourse.ca \
--cc=barebox@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox