diff mbox series

[v6] release-notes-4.1.rst remove bitbake-layers subcommand argument

Message ID 20221020065246.33834-1-ito@lineo.co.jp
State New
Headers show
Series [v6] release-notes-4.1.rst remove bitbake-layers subcommand argument | expand

Commit Message

Takayasu Ito Oct. 20, 2022, 6:52 a.m. UTC
From: Takayasu Ito <ito@lineo.co.jp>

Signed-off-by: Takayasu Ito <ito@lineo.co.jp>
---
 documentation/migration-guides/release-notes-4.1.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Michael Opdenacker Oct. 20, 2022, 6:56 a.m. UTC | #1
On 10/20/22 08:52, Takayasu Ito wrote:
> From: Takayasu Ito <ito@lineo.co.jp>
>
> Signed-off-by: Takayasu Ito <ito@lineo.co.jp>
> ---
>   documentation/migration-guides/release-notes-4.1.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)


Great, the patch applies correctly now.
Thanks
Michael.
Michael Opdenacker Oct. 20, 2022, 7:06 a.m. UTC | #2
Hi again Ito

Now that the patch is correct, let's talk about the proposed change 
itself...

On 10/20/22 08:52, Takayasu Ito wrote:
> From: Takayasu Ito <ito@lineo.co.jp>
>
> Signed-off-by: Takayasu Ito <ito@lineo.co.jp>
> ---
>   documentation/migration-guides/release-notes-4.1.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/documentation/migration-guides/release-notes-4.1.rst b/documentation/migration-guides/release-notes-4.1.rst
> index 0c552bf1a..a2d4b3d6c 100644
> --- a/documentation/migration-guides/release-notes-4.1.rst
> +++ b/documentation/migration-guides/release-notes-4.1.rst
> @@ -18,7 +18,7 @@ New Features / Enhancements in 4.1
>   
>     - New ``scripts/oe-setup-layers`` standalone script to restore the layer
>       configuration from a json file
> -  - New ``bitbake-layers create-layers-setup destdir`` command to save the
> +  - New ``bitbake-layers create-layers-setup`` command to save the
>       layer configuration to a json file
>     - New ``bitbake-layers save-build-conf`` command to save the active build
>       configuration as a template into a layer


I'm not sure what you propose to modify is correct though.

Here's what I have with the latest "master" branch from the poky repository:

$ bitbake-layers create-layers-setup

NOTE: Starting bitbake server...

usage: bitbake-layers create-layers-setup [-h] [--output-prefix OUTPUT_PREFIX] [--writer {oe-setup-layers}] [--json-only] destdir

bitbake-layers create-layers-setup: error: the following arguments are required: destdir

$ mkdir my-conf

$ bitbake-layers create-layers-setup my-conf

NOTE: Starting bitbake server...

NOTE: Created /home/mike/work/git/git.yoctoproject.org/build/my-conf/setup-layers.json

NOTE: Created /home/mike/work/git/git.yoctoproject.org/build/my-conf/setup-layers

Which version did you make your tests with? Or what misled you?
Cheers
Michael.
Takayasu Ito Oct. 20, 2022, 7:28 a.m. UTC | #3
Hi Michael

The subcommand save-build-conf, which was added at the same time, only 
contains the subcommand name and no parameters, so we have made a 
proposal to unify the notation.

If "bitbake-layers create-layers-setup destdir" is used, it would be 
better to use "bitbake-layers save-build-conf layerpath templatename" 
with the required parameters to unify the notation.

On 2022/10/20 16:06, Michael Opdenacker wrote:
> Hi again Ito
> 
> Now that the patch is correct, let's talk about the proposed change 
> itself...
> 
> On 10/20/22 08:52, Takayasu Ito wrote:
>> From: Takayasu Ito <ito@lineo.co.jp>
>>
>> Signed-off-by: Takayasu Ito <ito@lineo.co.jp>
>> ---
>>   documentation/migration-guides/release-notes-4.1.rst | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/documentation/migration-guides/release-notes-4.1.rst 
>> b/documentation/migration-guides/release-notes-4.1.rst
>> index 0c552bf1a..a2d4b3d6c 100644
>> --- a/documentation/migration-guides/release-notes-4.1.rst
>> +++ b/documentation/migration-guides/release-notes-4.1.rst
>> @@ -18,7 +18,7 @@ New Features / Enhancements in 4.1
>>     - New ``scripts/oe-setup-layers`` standalone script to restore the 
>> layer
>>       configuration from a json file
>> -  - New ``bitbake-layers create-layers-setup destdir`` command to 
>> save the
>> +  - New ``bitbake-layers create-layers-setup`` command to save the
>>       layer configuration to a json file
>>     - New ``bitbake-layers save-build-conf`` command to save the 
>> active build
>>       configuration as a template into a layer
> 
> 
> I'm not sure what you propose to modify is correct though.
> 
> Here's what I have with the latest "master" branch from the poky 
> repository:
> 
> $ bitbake-layers create-layers-setup
> 
> NOTE: Starting bitbake server...
> 
> usage: bitbake-layers create-layers-setup [-h] [--output-prefix 
> OUTPUT_PREFIX] [--writer {oe-setup-layers}] [--json-only] destdir
> 
> bitbake-layers create-layers-setup: error: the following arguments are 
> required: destdir
> 
> $ mkdir my-conf
> 
> $ bitbake-layers create-layers-setup my-conf
> 
> NOTE: Starting bitbake server...
> 
> NOTE: Created 
> /home/mike/work/git/git.yoctoproject.org/build/my-conf/setup-layers.json
> 
> NOTE: Created 
> /home/mike/work/git/git.yoctoproject.org/build/my-conf/setup-layers
> 
> Which version did you make your tests with? Or what misled you?
> Cheers
> Michael.
>
Alexander Kanavin Oct. 20, 2022, 7:29 a.m. UTC | #4
I agree with the change: only the command should be mentioned, and all
arguments should be left out, even if they're mandatory.

Alex

On Thu, 20 Oct 2022 at 09:28, Takayasu Ito <ito@lineo.co.jp> wrote:
>
> Hi Michael
>
> The subcommand save-build-conf, which was added at the same time, only
> contains the subcommand name and no parameters, so we have made a
> proposal to unify the notation.
>
> If "bitbake-layers create-layers-setup destdir" is used, it would be
> better to use "bitbake-layers save-build-conf layerpath templatename"
> with the required parameters to unify the notation.
>
> On 2022/10/20 16:06, Michael Opdenacker wrote:
> > Hi again Ito
> >
> > Now that the patch is correct, let's talk about the proposed change
> > itself...
> >
> > On 10/20/22 08:52, Takayasu Ito wrote:
> >> From: Takayasu Ito <ito@lineo.co.jp>
> >>
> >> Signed-off-by: Takayasu Ito <ito@lineo.co.jp>
> >> ---
> >>   documentation/migration-guides/release-notes-4.1.rst | 2 +-
> >>   1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> diff --git a/documentation/migration-guides/release-notes-4.1.rst
> >> b/documentation/migration-guides/release-notes-4.1.rst
> >> index 0c552bf1a..a2d4b3d6c 100644
> >> --- a/documentation/migration-guides/release-notes-4.1.rst
> >> +++ b/documentation/migration-guides/release-notes-4.1.rst
> >> @@ -18,7 +18,7 @@ New Features / Enhancements in 4.1
> >>     - New ``scripts/oe-setup-layers`` standalone script to restore the
> >> layer
> >>       configuration from a json file
> >> -  - New ``bitbake-layers create-layers-setup destdir`` command to
> >> save the
> >> +  - New ``bitbake-layers create-layers-setup`` command to save the
> >>       layer configuration to a json file
> >>     - New ``bitbake-layers save-build-conf`` command to save the
> >> active build
> >>       configuration as a template into a layer
> >
> >
> > I'm not sure what you propose to modify is correct though.
> >
> > Here's what I have with the latest "master" branch from the poky
> > repository:
> >
> > $ bitbake-layers create-layers-setup
> >
> > NOTE: Starting bitbake server...
> >
> > usage: bitbake-layers create-layers-setup [-h] [--output-prefix
> > OUTPUT_PREFIX] [--writer {oe-setup-layers}] [--json-only] destdir
> >
> > bitbake-layers create-layers-setup: error: the following arguments are
> > required: destdir
> >
> > $ mkdir my-conf
> >
> > $ bitbake-layers create-layers-setup my-conf
> >
> > NOTE: Starting bitbake server...
> >
> > NOTE: Created
> > /home/mike/work/git/git.yoctoproject.org/build/my-conf/setup-layers.json
> >
> > NOTE: Created
> > /home/mike/work/git/git.yoctoproject.org/build/my-conf/setup-layers
> >
> > Which version did you make your tests with? Or what misled you?
> > Cheers
> > Michael.
> >
>
> --
> リネオソリューションズ株式会社 本社
> 伊東孝康 <ito@lineo.co.jp>
> 〒399-0651 長野県塩尻市北小野1589-1
> Tel +81-263-56-2317 Fax +81-263-56-2319
>    ┏━━━━━━━━━━━━━━━━━━━━━━┓
> ┏┫   リネオは お客様の これりな を後押し   ┣┓
> ┃┗┳━━━━━━━━━━━━━━━━━━━━┳┛┃
> ┗━┛         https://www.lineo.co.jp        ┗━┛
> ┏━━━━━━━━━━━━━━━━━━━━━━━┓
> ┃ これりな = これからはLinux / これからもLinux ┃
> ┗━━━━━━━━━━━━━━━━━━━━━━━┛
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#3388): https://lists.yoctoproject.org/g/docs/message/3388
> Mute This Topic: https://lists.yoctoproject.org/mt/94448743/1686489
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [alex.kanavin@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>
Michael Opdenacker Oct. 20, 2022, 7:35 a.m. UTC | #5
On 10/20/22 09:29, Alexander Kanavin wrote:
> I agree with the change: only the command should be mentioned, and all
> arguments should be left out, even if they're mandatory.
>
> Alex
>
> On Thu, 20 Oct 2022 at 09:28, Takayasu Ito <ito@lineo.co.jp> wrote:
>> Hi Michael
>>
>> The subcommand save-build-conf, which was added at the same time, only
>> contains the subcommand name and no parameters, so we have made a
>> proposal to unify the notation.
>>
>> If "bitbake-layers create-layers-setup destdir" is used, it would be
>> better to use "bitbake-layers save-build-conf layerpath templatename"
>> with the required parameters to unify the notation.


Ok, makes sense, thanks!
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
... and merged into "master-next".

Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/migration-guides/release-notes-4.1.rst b/documentation/migration-guides/release-notes-4.1.rst
index 0c552bf1a..a2d4b3d6c 100644
--- a/documentation/migration-guides/release-notes-4.1.rst
+++ b/documentation/migration-guides/release-notes-4.1.rst
@@ -18,7 +18,7 @@  New Features / Enhancements in 4.1
 
   - New ``scripts/oe-setup-layers`` standalone script to restore the layer
     configuration from a json file
-  - New ``bitbake-layers create-layers-setup destdir`` command to save the
+  - New ``bitbake-layers create-layers-setup`` command to save the
     layer configuration to a json file
   - New ``bitbake-layers save-build-conf`` command to save the active build
     configuration as a template into a layer