[PATCH 1/3] dev-manual: fix styling of references to bmaptool

[PATCH 1/3] dev-manual: fix styling of references to bmaptool

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@rootcommit.com>

To follow the styling conventions when we are
refering to the name of a tool instead of the command itself
(documentation/standards.md).

This also improves the HTML rendering of the bmaptools subsection.

Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
---
 documentation/dev-manual/bmaptool.rst | 18 +++++++++---------
 documentation/dev-manual/wic.rst      |  4 ++--
 2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
index f6f0e6afaf..493abf7607 100644
--- a/documentation/dev-manual/bmaptool.rst
+++ b/documentation/dev-manual/bmaptool.rst
@@ -1,13 +1,13 @@
 .. SPDX-License-Identifier: CC-BY-SA-2.0-UK
 
-Flashing Images Using ``bmaptool``
-**********************************
+Flashing Images Using `bmaptool`
+********************************
 
 A fast and easy way to flash an image to a bootable device is to use
-bmaptool, which is integrated into the OpenEmbedded build system.
-bmaptool is a generic tool that creates a file's block map (bmap) and
+`bmaptool`, which is integrated into the OpenEmbedded build system.
+`bmaptool` is a generic tool that creates a file's block map (bmap) and
 then uses that map to copy the file. As compared to traditional tools
-such as dd or cp, bmaptool can copy (or flash) large files like raw
+such as `dd` or `cp`, `bmaptool` can copy (or flash) large files like raw
 system image files much faster.
 
 .. note::
@@ -20,13 +20,13 @@ system image files much faster.
          $ sudo apt install bmap-tools
 
    -  If you are unable to install the ``bmap-tools`` package, you will
-      need to build bmaptool before using it. Use the following command::
+      need to build `bmaptool` before using it. Use the following command::
 
          $ bitbake bmaptool-native
 
 Following, is an example that shows how to flash a Wic image. Realize
-that while this example uses a Wic image, you can use bmaptool to flash
-any type of image. Use these steps to flash an image using bmaptool:
+that while this example uses a Wic image, you can use `bmaptool` to flash
+any type of image. Use these steps to flash an image using `bmaptool`:
 
 #. *Update your local.conf File:* You need to have the following set
    in your ``local.conf`` file before building your image::
@@ -39,7 +39,7 @@ any type of image. Use these steps to flash an image using bmaptool:
 
       $ bitbake image
 
-#. *Flash the Device:* Flash the device with the image by using bmaptool
+#. *Flash the Device:* Flash the device with the image by using `bmaptool`
    depending on your particular setup. The following commands assume the
    image resides in the :term:`Build Directory`'s ``deploy/images/`` area:
 
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index a3880f3a1c..fced0e170c 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -513,7 +513,7 @@ or ::
 
    For more information on how to use the ``bmaptool``
    to flash a device with an image, see the
-   ":ref:`dev-manual/bmaptool:flashing images using \`\`bmaptool\`\``"
+   ":ref:`dev-manual/bmaptool:flashing images using \`bmaptool\``"
    section.
 
 Using a Modified Kickstart File
@@ -721,7 +721,7 @@ the existing kernel, and then inserts a new kernel:
 
    Once the new kernel is added back into the image, you can use the
    ``dd`` command or :ref:`bmaptool
-   <dev-manual/bmaptool:flashing images using \`\`bmaptool\`\`>`
+   <dev-manual/bmaptool:flashing images using \`bmaptool\`>` commands
    to flash your wic image onto an SD card or USB stick and test your
    target.
 

[PATCH 2/3] dev-manual/bmaptool.rst: add missing command for bmaptool-native

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@rootcommit.com>

Otherwise, running "oe-run-native bmaptool-native bmaptool ..."
fails as follows:

Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'?

Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
---
 documentation/dev-manual/bmaptool.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
index 493abf7607..5fc46c7792 100644
--- a/documentation/dev-manual/bmaptool.rst
+++ b/documentation/dev-manual/bmaptool.rst
@@ -23,6 +23,7 @@ system image files much faster.
       need to build `bmaptool` before using it. Use the following command::
 
          $ bitbake bmaptool-native
+         $ bitbake bmaptool-native -caddto_recipe_sysroot
 
 Following, is an example that shows how to flash a Wic image. Realize
 that while this example uses a Wic image, you can use `bmaptool` to flash

Re: [docs] [PATCH 2/3] dev-manual/bmaptool.rst: add missing command for bmaptool-native

[Antonin Godard]

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>
>
> Otherwise, running "oe-run-native bmaptool-native bmaptool ..."
> fails as follows:
>
> Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'?
>
> Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
> ---
>  documentation/dev-manual/bmaptool.rst | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
> index 493abf7607..5fc46c7792 100644
> --- a/documentation/dev-manual/bmaptool.rst
> +++ b/documentation/dev-manual/bmaptool.rst
> @@ -23,6 +23,7 @@ system image files much faster.
>        need to build `bmaptool` before using it. Use the following command::

s/command/commands/ or see comment below

>  
>           $ bitbake bmaptool-native
> +         $ bitbake bmaptool-native -caddto_recipe_sysroot

Isn't running `bitbake bmaptool-native -caddto_recipe_sysroot` enough? I
would say addto_recipe_sysroot implies building the recipe, but I might be
wrong!

Regards,
Antonin

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

Re: [docs] [PATCH 2/3] dev-manual/bmaptool.rst: add missing command for bmaptool-native

[Michael Opdenacker]

Hi Antonin

On 12/2/24 10:02, Antonin Godard wrote:
> 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>
>>
>> Otherwise, running "oe-run-native bmaptool-native bmaptool ..."
>> fails as follows:
>>
>> Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'?
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
>> ---
>>   documentation/dev-manual/bmaptool.rst | 1 +
>>   1 file changed, 1 insertion(+)
>>
>> diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
>> index 493abf7607..5fc46c7792 100644
>> --- a/documentation/dev-manual/bmaptool.rst
>> +++ b/documentation/dev-manual/bmaptool.rst
>> @@ -23,6 +23,7 @@ system image files much faster.
>>         need to build `bmaptool` before using it. Use the following command::
> s/command/commands/ or see comment below
>
>>   
>>            $ bitbake bmaptool-native
>> +         $ bitbake bmaptool-native -caddto_recipe_sysroot
> Isn't running `bitbake bmaptool-native -caddto_recipe_sysroot` enough? I
> would say addto_recipe_sysroot implies building the recipe, but I might be
> wrong!

Good catch. Indeed the second command is enough.
I'm preparing an update.

Thanks!
Michael.

-- 
Michael Opdenacker
Root Commit
Embedded Linux Training and Consulting
https://rootcommit.com/

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

[michael.opdenacker]

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
+
+   -  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::

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

[Ulrich Ölmann]

Hey Michael,

On Sun, Dec 01 2024 at 17:38 +0000, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=rootcommit.com@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

a small typo slipped in here: s/such/sudo/

Best regards
Ulrich


> +
> +   -  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::
>
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#5860): https://lists.yoctoproject.org/g/docs/message/5860
> Mute This Topic: https://lists.yoctoproject.org/mt/109865516/3618626
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [u.oelmann@pengutronix.de]
> -=-=-=-=-=-=-=-=-=-=-=-
-- 
Pengutronix e.K.                           | Ulrich Ölmann               |
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 |

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

[Michael Opdenacker]

Hey Ulrich

On 12/1/24 20:26, Ulrich Ölmann wrote:
> Hey Michael,
>
> On Sun, Dec 01 2024 at 17:38 +0000, "Michael Opdenacker via lists.yoctoproject.org" <michael.opdenacker=rootcommit.com@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
> a small typo slipped in here: s/such/sudo/


Oops, fixed!
Thanks for the review.
Cheers
Michael.

-- 
Michael Opdenacker
Root Commit
Embedded Linux Training and Consulting
https://rootcommit.com/

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

[Antonin Godard]

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

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

[Michael Opdenacker]

Hi Antonin

Thanks for the review!

On 12/2/24 10:02, Antonin Godard wrote:
> 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?


I wondered too. Let's do it, I agree.

>
> 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.


Right, this makes no sense to give this recommendation before "sudo".
My V2 will recommend chmod right before running oe-run-native.

Cheers
Michael.

-- 
Michael Opdenacker
Root Commit
Embedded Linux Training and Consulting
https://rootcommit.com/

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

[Michael Opdenacker]

On 12/4/24 10:26, Michael Opdenacker wrote:
> Hi AntoninI know this was already instructed before, but maybe `chmod 
> o+w` is a better
>> practice and advice to give. What do you think?
>
>
> I wondered too. Let's do it, I agree.


Actually "chmod a+w". On my Ubuntu system, "o+w" would have worked, but 
there may be other systems on which the user either owns the device file 
or belongs to its group.
Michael.

-- 
Michael Opdenacker
Root Commit
Embedded Linux Training and Consulting
https://rootcommit.com/

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

[Antonin Godard]

Hi Michael,

On Wed Dec 4, 2024 at 10:33 AM CET, Michael Opdenacker wrote:
>
> On 12/4/24 10:26, Michael Opdenacker wrote:
>> Hi AntoninI know this was already instructed before, but maybe `chmod 
>> o+w` is a better
>>> practice and advice to give. What do you think?
>>
>>
>> I wondered too. Let's do it, I agree.
>
>
> Actually "chmod a+w". On my Ubuntu system, "o+w" would have worked, but 
> there may be other systems on which the user either owns the device file 
> or belongs to its group.
> Michael.

Yes indeed "chmod a+w" covers all use use cases so let's go for that :)

Antonin

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