From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from astoria.ccjclearline.com ([64.235.106.9]) by bombadil.infradead.org with esmtps (Exim 4.80.1 #2 (Red Hat Linux)) id 1X0tSp-0008RI-7Q for barebox@lists.infradead.org; Sat, 28 Jun 2014 14:18:48 +0000 Received: from [99.240.204.5] (port=42314 helo=crashcourse.ca) by astoria.ccjclearline.com with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.80) (envelope-from ) id 1X0tS5-0006rV-St for barebox@lists.infradead.org; Sat, 28 Jun 2014 10:18:01 -0400 Date: Sat, 28 Jun 2014 10:13:55 -0400 (EDT) From: "Robert P. J. Day" Message-ID: MIME-Version: 1.0 List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "barebox" Errors-To: barebox-bounces+u.kleine-koenig=pengutronix.de@lists.infradead.org Subject: [PATCH] Documentation: Clean up sandbox.rst, use definition list. To: "U-Boot Version 2 (barebox)" 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 --- 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 [\] + $ barebox [] -Options can be:: +Available sandbox invocation options include: - -m, --malloc=\ + ``-m``, ``--malloc=`` -Start sandbox with a specified malloc-space \ in bytes. + Start sandbox with a specified malloc-space in bytes. -:: + ``-i `` - -i \ + Map a to barebox. This option can be given multiple times. The s + will show up as ``/dev/fd0`` ... ``/dev/fdX`` in the barebox simulator. -Map a \ to barebox. This option can be given multiple times. The \s -will show up as /dev/fd0 ... /dev/fdx in the barebox simulator. + ``-e `` -:: + Map to barebox. With this option 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 \ + ``-O `` -Map \ to barebox. With this option \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 as a console capable of doing stdout. can be a + regular file or a FIFO. -:: + ``-I `` - -O \ + Register as a console capable of doing stdin. can be a regular + file or a FIFO. -Register \ as a console capable of doing stdout. \ can be a -regular file or a fifo. + ``-x``, ``--xres `` -:: + Specify SDL width. - -I \ + ``-y``, ``--yres `` -Register \ as a console capable of doing stdin. \ can be a regular -file or a fifo. - -:: - - -x, --xres \ - -Specify SDL width - -:: - - -y, --yres \ - -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