diff mbox series

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

Message ID 20241204104432.2094236-4-michael.opdenacker@rootcommit.com
State New
Headers show
Series Improvements to "bmaptool" usage documentation | expand

Commit Message

Michael Opdenacker Dec. 4, 2024, 10:44 a.m. UTC
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(-)

Comments

Antonin Godard Dec. 4, 2024, 12:19 p.m. UTC | #1
On Wed Dec 4, 2024 at 11:44 AM 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 37083c9c64..93c8d3a45e 100644
> --- a/documentation/dev-manual/bmaptool.rst
> +++ b/documentation/dev-manual/bmaptool.rst
> @@ -43,14 +43,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
> +         $ sudo chmod 666 /dev/sdX

I think you forgot to change to "a+w"
Also, it wasn't moved after the sudo command?

Looks like the wrong patch may have slipped in? :)

> -   -  If you do not have write access to the media, set your permissions
> -      first and then use the same command form::
> +   -  If you installed the package for `bmaptool`, you can directly run::
> +
> +         $ sudo bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
> +
> +   -  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::


Antonin
Michael Opdenacker Dec. 4, 2024, 1:03 p.m. UTC | #2
Hi Antonin

On 12/4/24 13:19, Antonin Godard wrote:
> On Wed Dec 4, 2024 at 11:44 AM 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 37083c9c64..93c8d3a45e 100644
>> --- a/documentation/dev-manual/bmaptool.rst
>> +++ b/documentation/dev-manual/bmaptool.rst
>> @@ -43,14 +43,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
>> +         $ sudo chmod 666 /dev/sdX
> I think you forgot to change to "a+w"
> Also, it wasn't moved after the sudo command?
>
> Looks like the wrong patch may have slipped in? :)


Right, I messed things up by modifying the second commit.
A V3 is coming, thanks!
Michael.
Antonin Godard Dec. 18, 2024, 9:35 a.m. UTC | #3
Hi Michael,

On Wed Dec 4, 2024 at 2:03 PM CET, Michael Opdenacker wrote:
> Hi Antonin
>
> On 12/4/24 13:19, Antonin Godard wrote:
>> On Wed Dec 4, 2024 at 11:44 AM 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 37083c9c64..93c8d3a45e 100644
>>> --- a/documentation/dev-manual/bmaptool.rst
>>> +++ b/documentation/dev-manual/bmaptool.rst
>>> @@ -43,14 +43,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
>>> +         $ sudo chmod 666 /dev/sdX
>> I think you forgot to change to "a+w"
>> Also, it wasn't moved after the sudo command?
>>
>> Looks like the wrong patch may have slipped in? :)
>
>
> Right, I messed things up by modifying the second commit.
> A V3 is coming, thanks!

I did not receive it the v3, not sure you sent it? Just want to check whether
I missed it or not.


Antonin
Michael Opdenacker Dec. 18, 2024, 2:49 p.m. UTC | #4
Hi Antonin,

On 12/18/24 10:35, Antonin Godard wrote:
> Hi Michael,
>
> On Wed Dec 4, 2024 at 2:03 PM CET, Michael Opdenacker wrote:
>> Hi Antonin
>>
>> On 12/4/24 13:19, Antonin Godard wrote:
>>> On Wed Dec 4, 2024 at 11:44 AM 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 37083c9c64..93c8d3a45e 100644
>>>> --- a/documentation/dev-manual/bmaptool.rst
>>>> +++ b/documentation/dev-manual/bmaptool.rst
>>>> @@ -43,14 +43,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
>>>> +         $ sudo chmod 666 /dev/sdX
>>> I think you forgot to change to "a+w"
>>> Also, it wasn't moved after the sudo command?
>>>
>>> Looks like the wrong patch may have slipped in? :)
>>
>> Right, I messed things up by modifying the second commit.
>> A V3 is coming, thanks!
> I did not receive it the v3, not sure you sent it? Just want to check whether
> I missed it or not.


Oops, thanks for the reminder. I believe I had sent it, but indeed, no!
Done now.
Thanks
Michael.
diff mbox series

Patch

diff --git a/documentation/dev-manual/bmaptool.rst b/documentation/dev-manual/bmaptool.rst
index 37083c9c64..93c8d3a45e 100644
--- a/documentation/dev-manual/bmaptool.rst
+++ b/documentation/dev-manual/bmaptool.rst
@@ -43,14 +43,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
+         $ sudo chmod 666 /dev/sdX
 
-   -  If you do not have write access to the media, set your permissions
-      first and then use the same command form::
+   -  If you installed the package for `bmaptool`, you can directly run::
+
+         $ sudo bmaptool copy build-directory/tmp/deploy/images/machine/image.wic /dev/sdX
+
+   -  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::