Re: [docs] [PATCH 3/3] dev-manual/bmaptool.rst: simplify and fix instructions

["Antonin Godard" <antonin.godard@bootlin.com>]

Hi Michael,

On Sun Dec 1, 2024 at 6:38 PM CET, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@rootcommit.com>
>
> - Remove duplicate instructions
>
> - Detail how to run bmaptool directly if you installed it on your host
>   instead of building it through the ``bmaptool-native`` recipe,
>   as running "oe-run-native bmaptool-native bmaptool ..." won't work
>   in this case.
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
> ---
>  documentation/dev-manual/bmaptool.rst | 12 +++++++-----
>  1 file changed, 7 insertions(+), 5 deletions(-)
>
> diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
> index 5fc46c7792..e17074b65b 100644
> --- a/documentation/dev-manual/bmaptool.rst
> +++ b/documentation/dev-manual/bmaptool.rst
> @@ -44,14 +44,16 @@ any type of image. Use these steps to flash an image using `bmaptool`:
>     depending on your particular setup. The following commands assume the
>     image resides in the :term:`Build Directory`'s ``deploy/images/`` area:
>  
> -   -  If you have write access to the media, use this command form::
> +   -  If needed, set permissions to get write access to the media::
>  
> -         $ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
> +         $ such chmod 666 /dev/sdX

I know this was already instructed before, but maybe `chmod o+w` is a better
practice and advice to give. What do you think?

Also I think this recommendation could be given after the sudo command, since it
shouldn't be a problem to write to the device as root. I'm assuming the `chmod
o+w` instruction was added here because oe-run-native doesn't run as root.

> +
> +   -  If you installed the package for `bmaptool`, you can directly run::
> +
> +         $ sudo bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
>  
> -   -  If you do not have write access to the media, set your permissions
> -      first and then use the same command form::
> +   -  Otherwise, if you built `bmaptool` with BitBake, run::
>  
> -         $ sudo chmod 666 /dev/sdX
>           $ oe-run-native bmaptool-native bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
>  
>  For help on the ``bmaptool`` command, use the following command::

Regards,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com