[PATCH] Documentation: boards: sandbox: describe --image flags

[PATCH] Documentation: boards: sandbox: describe --image flags

[Ahmad Fatoum]

barebox partition table parsing can be tested in sandbox using the
recently added ,blkdev flag. Extend the documentation to cover this.

Cc: Juergen Borleis <jbe@pengutronix.de>
Reported-by: Lucas Stach <lst@pengutronix.de>
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
 Documentation/boards/sandbox.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Documentation/boards/sandbox.rst b/Documentation/boards/sandbox.rst
index 8b24b6a64584..e9e5183653e6 100644
--- a/Documentation/boards/sandbox.rst
+++ b/Documentation/boards/sandbox.rst
@@ -34,6 +34,20 @@ Available sandbox invocation options include:
     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.
 
+    How the file is mapped in barebox can be controlled by a number of flags:
+
+    * ``,ro``: The host file is mapped read-only
+
+    * ``,blkdev``: The host file is to be mapped as block device. This is the
+      default when passing block devices from the host. The file's size must
+      be a multiple of the barebox sector size of 512 bytes.
+
+    * ``,cdev``: The host file is mapped as character device. This is the default,
+      unless the the host file is a block device.
+
+    Multiple options can be appended if they don't clash. Literal commas within the
+    file path can be escaped with a backslash. Example: ``-i './0\,0.hdimg,blkdev,ro'``.
+
   ``-e <file>``
 
     Map <file> to barebox. With this option <file>s are mapped as
-- 
2.30.0


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

Re: [PATCH] Documentation: boards: sandbox: describe --image flags

[Sascha Hauer]

On Mon, Jan 11, 2021 at 03:35:55PM +0100, Ahmad Fatoum wrote:
> barebox partition table parsing can be tested in sandbox using the
> recently added ,blkdev flag. Extend the documentation to cover this.
> 
> Cc: Juergen Borleis <jbe@pengutronix.de>
> Reported-by: Lucas Stach <lst@pengutronix.de>
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
>  Documentation/boards/sandbox.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)

Applied, thanks

Sascha

> 
> diff --git a/Documentation/boards/sandbox.rst b/Documentation/boards/sandbox.rst
> index 8b24b6a64584..e9e5183653e6 100644
> --- a/Documentation/boards/sandbox.rst
> +++ b/Documentation/boards/sandbox.rst
> @@ -34,6 +34,20 @@ Available sandbox invocation options include:
>      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.
>  
> +    How the file is mapped in barebox can be controlled by a number of flags:
> +
> +    * ``,ro``: The host file is mapped read-only
> +
> +    * ``,blkdev``: The host file is to be mapped as block device. This is the
> +      default when passing block devices from the host. The file's size must
> +      be a multiple of the barebox sector size of 512 bytes.
> +
> +    * ``,cdev``: The host file is mapped as character device. This is the default,
> +      unless the the host file is a block device.
> +
> +    Multiple options can be appended if they don't clash. Literal commas within the
> +    file path can be escaped with a backslash. Example: ``-i './0\,0.hdimg,blkdev,ro'``.
> +
>    ``-e <file>``
>  
>      Map <file> to barebox. With this option <file>s are mapped as
> -- 
> 2.30.0
> 
> 
> _______________________________________________
> barebox mailing list
> barebox@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/barebox
> 

-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
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