Skip to contentSkip to conversation

bitbake: update help message for dump-signatures

PATCH In review Robert Yang 3 participants 13 messages Jul 4, 2014 – Jul 22, 2014

lore
Share & tools
lore
#0 lore raw

cover bitbake: update help message for dump-signatures

The following changes since commit 0ed5a13f5f9478e2c22f517fb3504b738422f85c:

python3: fix builtins imports (2014-06-30 16:36:44 +0100)

are available in the git repository at:

git://git.pokylinux.org/poky-contrib rbt/sig
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=rbt/sig

Robert Yang (2):
bitbake: update help message for dump-signatures bitbake-user-manual-intro.xml: update for dump-signatures

 bitbake/bin/bitbake                                |    4 ++--
 .../bitbake-user-manual-intro.xml                  |   10 ++++++----
 2 files changed, 8 insertions(+), 6 deletions(-)
Signature · 1 line
1.7.9.5
#1 lore raw

PATCH 1/2 bitbake: update help message for dump-signatures

The bitbake -S had been updated which always reuires an argument, so update the help info:
- Add the two args in the help message: none and printdiff

- Use type="choice" so that we can get more friendly error messages,
for example:
bitbake: error: option -S: invalid choice: 'printdiffX' (choose from 'none', 'printdiff')

- dump-signatures=DUMP_SIGNATURES -> dump-signatures=SIGNATURE_HANDLER

---
 bitbake/bin/bitbake |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
bitbake/bin/bitbake +2 -2
index b3acbe1..5c25a9d 100755
@@ -139,8 +139,8 @@ class BitBakeConfigParameters(cookerdata.ConfigParameters):
         parser.add_option("-n", "--dry-run", help = "Don't execute, just go through the motions.",
                    action = "store_true", dest = "dry_run", default = False)
 
-        parser.add_option("-S", "--dump-signatures", help = "Dump out the signature construction information, with no task execution. Parameters are passed to the signature handling code, use 'none' if no specific handler is required.",
-                   action = "append", dest = "dump_signatures", default = [])
+        parser.add_option("-S", "--dump-signatures", help = "Dump out the signature construction information, with no task execution. The SIGNATURE_HANDLER can be none or printdiff, while none means only dump the signature, printdiff means compare the dumped signature with the cached one.",
+                   action = "append", dest = "dump_signatures", default = [], type="choice", choices=("none", "printdiff"), metavar="SIGNATURE_HANDLER")
 
         parser.add_option("-p", "--parse-only", help = "Quit after parsing the BB recipes.",
                    action = "store_true", dest = "parse_only", default = False)
Signature · 1 line
1.7.9.5
#2 lore raw
Quoted 20 lines · Robert Yang

The bitbake -S had been updated which always reuires an argument, so update the help info:
- Add the two args in the help message: none and printdiff

- Use type="choice" so that we can get more friendly error messages,
for example:
bitbake: error: option -S: invalid choice: 'printdiffX' (choose from 'none', 'printdiff')

- dump-signatures=DUMP_SIGNATURES -> dump-signatures=SIGNATURE_HANDLER

---
 bitbake/bin/bitbake |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
bitbake/bin/bitbake +0 -0
index b3acbe1..5c25a9d 100755

bitbake/bin/bitbake class BitBakeConfigParameters(cookerdata.ConfigParameters): · line 143

Quoted 7 lines
bitbake/bin/bitbake +2 -2
@@ -139,8 +139,8 @@ class BitBakeConfigParameters(cookerdata.ConfigParameters):
         parser.add_option("-n", "--dry-run", help = "Don't execute, just go through the motions.",
                    action = "store_true", dest = "dry_run", default = False)
 
-        parser.add_option("-S", "--dump-signatures", help = "Dump out the signature construction information, with no task execution. Parameters are passed to the signature handling code, use 'none' if no specific handler is required.",
-                   action = "append", dest = "dump_signatures", default = [])
+        parser.add_option("-S", "--dump-signatures", help = "Dump out the signature construction information, with no task execution. The SIGNATURE_HANDLER can be none or printdiff, while none means only dump the signature, printdiff means compare the dumped signature with the cached one.",
+                   action = "append", dest = "dump_signatures", default = [], type="choice", choices=("none", "printdiff"), metavar="SIGNATURE_HANDLER")

The problem here is the different options are (or will be) metadata defined and bitbake can't know which options may or may not be valid :(

Cheers,

Richard

#3 lore raw
Quoted 24 lines · Richard Purdie
Quoted 23 lines · Robert Yang

The bitbake -S had been updated which always reuires an argument, so update the help info:
- Add the two args in the help message: none and printdiff

- Use type="choice" so that we can get more friendly error messages,
for example:
bitbake: error: option -S: invalid choice: 'printdiffX' (choose from 'none', 'printdiff')

- dump-signatures=DUMP_SIGNATURES -> dump-signatures=SIGNATURE_HANDLER

---
  bitbake/bin/bitbake |    4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)
bitbake/bin/bitbake +0 -0
index b3acbe1..5c25a9d 100755
@@ -139,8 +139,8 @@ class BitBakeConfigParameters(cookerdata.ConfigParameters):
          parser.add_option("-n", "--dry-run", help = "Don't execute, just go through the motions.",
                     action = "store_true", dest = "dry_run", default = False)
 
Quoted 7 lines

bitbake/bin/bitbake class BitBakeConfigParameters(cookerdata.ConfigParameters): · line 143

Quoted 4 lines
bitbake/bin/bitbake +2 -2
-        parser.add_option("-S", "--dump-signatures", help = "Dump out the signature construction information, with no task execution. Parameters are passed to the signature handling code, use 'none' if no specific handler is required.",
-                   action = "append", dest = "dump_signatures", default = [])
+        parser.add_option("-S", "--dump-signatures", help = "Dump out the signature construction information, with no task execution. The SIGNATURE_HANDLER can be none or printdiff, while none means only dump the signature, printdiff means compare the dumped signature with the cached one.",
+                   action = "append", dest = "dump_signatures", default = [], type="choice", choices=("none", "printdiff"), metavar="SIGNATURE_HANDLER")

The problem here is the different options are (or will be) metadata defined and bitbake can't know which options may or may not be valid :(

Thanks, how about remove the type="choice" and update the help info to:

-S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
Dump out the signature construction information, with no task execution. The SIGNATURE_HANDLER can be none, printdiff or other metadata defined handlers, while none means only dump the signature, printdiff means compare the dumped signature with the cached one.

Or drop the patch and update the user manual ?

I updated it was because when I used the bitbake -S, I didn't know there is a very useful handler printdiff.

// Robert

Quoted 7 lines

Cheers,

Richard

#4 lore raw

PATCH 2/2 bitbake-user-manual-intro.xml: update for dump-signatures

In reply to Robert Yang
---
 .../bitbake-user-manual-intro.xml                  |   10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +6 -4
index ae267b4..e4025a8 100644
@@ -471,11 +471,13 @@
        -D, --debug           Increase the debug level. You can specify this more
                              than once.
        -n, --dry-run         Don't execute, just go through the motions.
-       -S DUMP_SIGNATURES, --dump-signatures=DUMP_SIGNATURES
+       -S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
                              Dump out the signature construction information, with
-                             no task execution. Parameters are passed to the
-                             signature handling code, use 'none' if no specific
-                             handler is required.
+                             no task execution. The SIGNATURE_HANDLER can be none
+                             or printdiff, while none means only dump the
+                             signature, printdiff means compare the dumped
+                             signature with the cached one.
+
        -p, --parse-only      Quit after parsing the BB recipes.
        -s, --show-versions   Show current and preferred versions of all recipes.
        -e, --environment     Show the global or per-package environment complete
Signature · 1 line
1.7.9.5
#5 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

Patch applied,

Thanks,
Scott

Quoted 45 lines

-----Original Message-----
From: [email protected] [mailto:bitbake- [email protected]] On Behalf Of Robert Yang
Sent: Thursday, July 03, 2014 10:39 PM
To: [email protected]
Subject: [bitbake-devel] [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

---
.../bitbake-user-manual-intro.xml | 10 ++++++----

1 file changed, 6 insertions(+), 4 deletions(-)
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +6 -4
index ae267b4..e4025a8 100644
@@ -471,11 +471,13 @@
       -D, --debug           Increase the debug level. You can specify this more
                             than once.
       -n, --dry-run         Don't execute, just go through the motions.
-       -S DUMP_SIGNATURES, --dump-signatures=DUMP_SIGNATURES
+       -S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
                             Dump out the signature construction information, with
-                             no task execution. Parameters are passed to the
-                             signature handling code, use 'none' if no specific
-                             handler is required.
+                             no task execution. The SIGNATURE_HANDLER can be none
+                             or printdiff, while none means only dump the
+                             signature, printdiff means compare the dumped
+                             signature with the cached one.
+
       -p, --parse-only      Quit after parsing the BB recipes.
       -s, --show-versions   Show current and preferred versions of all recipes.
       -e, --environment     Show the global or per-package environment

complete
--
1.7.9.5

--
_______________________________________________
bitbake-devel mailing list
[email protected]
http://lists.openembedded.org/mailman/listinfo/bitbake-devel

#6 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

Quoted 2 lines · Scott M

Patch applied,

Sorry, this has not been approved, we need wait for RP's comments and update it, and we should merge the part for bitbake first.

// Robert

Quoted 50 lines

Thanks,
Scott

Quoted 45 lines

-----Original Message-----
From: [email protected] [mailto:bitbake- [email protected]] On Behalf Of Robert Yang
Sent: Thursday, July 03, 2014 10:39 PM
To: [email protected]
Subject: [bitbake-devel] [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

---
.../bitbake-user-manual-intro.xml | 10 ++++++----

1 file changed, 6 insertions(+), 4 deletions(-)
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +6 -4
index ae267b4..e4025a8 100644
@@ -471,11 +471,13 @@
        -D, --debug           Increase the debug level. You can specify this more
                              than once.
        -n, --dry-run         Don't execute, just go through the motions.
-       -S DUMP_SIGNATURES, --dump-signatures=DUMP_SIGNATURES
+       -S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
                              Dump out the signature construction information, with
-                             no task execution. Parameters are passed to the
-                             signature handling code, use 'none' if no specific
-                             handler is required.
+                             no task execution. The SIGNATURE_HANDLER can be none
+                             or printdiff, while none means only dump the
+                             signature, printdiff means compare the dumped
+                             signature with the cached one.
+
        -p, --parse-only      Quit after parsing the BB recipes.
        -s, --show-versions   Show current and preferred versions of all recipes.
        -e, --environment     Show the global or per-package environment

complete
--
1.7.9.5

--
_______________________________________________
bitbake-devel mailing list
[email protected]
http://lists.openembedded.org/mailman/listinfo/bitbake-devel

#7 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

Ok - if there is a problem or changes then let me know. I have the doc changes pushed to poky-contrib/srifenbark/bb-manual only. Richard would have to merge them from there into the upstream bitbake repository.

Scott

Quoted 70 lines

-----Original Message-----
From: Robert Yang [mailto:[email protected]]
Sent: Sunday, July 06, 2014 11:16 PM
To: Rifenbark, Scott M; [email protected]
Subject: Re: [bitbake-devel] [PATCH 2/2] bitbake-user-manual-intro.xml:
update for dump-signatures

Quoted 2 lines · Scott M

Patch applied,

Sorry, this has not been approved, we need wait for RP's comments and update it, and we should merge the part for bitbake first.

// Robert

Quoted 31 lines

Thanks,
Scott

Quoted 28 lines

-----Original Message-----
From: [email protected] [mailto:bitbake- [email protected]] On Behalf Of Robert Yang
Sent: Thursday, July 03, 2014 10:39 PM
To: [email protected]
Subject: [bitbake-devel] [PATCH 2/2] bitbake-user-manual-intro.xml:
update for dump-signatures

---
.../bitbake-user-manual-intro.xml | 10 ++++++----

1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml index ae267b4..e4025a8 100644

bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +1 -3
@@ -471,11 +471,13 @@
        -D, --debug           Increase the debug level. You can specify this more
                              than once.
        -n, --dry-run         Don't execute, just go through the motions.
-       -S DUMP_SIGNATURES, --dump-signatures=DUMP_SIGNATURES
+       -S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER
                              Dump out the signature construction information, with
-                             no task execution. Parameters are passed to the
-                             signature handling code, use 'none' if no specific
Quoted 8 lines

bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml

Quoted 8 lines
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +5 -1
-                             handler is required.
+                             no task execution. The SIGNATURE_HANDLER can be none
+                             or printdiff, while none means only dump the
+                             signature, printdiff means compare the dumped
+                             signature with the cached one.
+
        -p, --parse-only      Quit after parsing the BB recipes.
        -s, --show-versions   Show current and preferred versions of all

recipes.

Quoted 12 lines
Quoted 10 lines
bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.xml +0 -0
        -e, --environment     Show the global or per-package environment

complete
--
1.7.9.5

--
_______________________________________________
bitbake-devel mailing list
[email protected]
http://lists.openembedded.org/mailman/listinfo/bitbake-devel

#8 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

Quoted 4 lines · Scott M

Ok - if there is a problem or changes then let me know. I have the doc changes pushed to poky-contrib/srifenbark/bb-manual only. Richard would have to merge them from there into the upstream bitbake repository.

I modified Roberts patch a bit. Could you update the manual based on that patch? I didn't take the change for the manual you have queued for this, I'd suggest we create a new one. I did merge everything else in your bitbake manual branch.

Cheers,

Richard

#9 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

Richard,

I pulled 'poky/master' to be sure I had latest code and reproduced the 'bitbake -h' output to see what is there. From that, I updated the example output in the bitbake manual and pushed to contrib at srifenbark/bb-manual. Along with that updated dump signatures stuff I also noted that the option '--token=XMLRPCTOKEN' appeared to not have been in the help output in the manual. So, because the stuff in the manual is an exact copy of the actual help output, I have refreshed the example with the actual output, which includes --token as well.

The changes are pushed to contrib on srifenbark/bb-manual. Notice also that Robert (30 minutes prior to my push) also has a commit that fixed the dump signature stuff I suspect based on your email to this group. You should probably merge my commit as it contains the --token option and the fixed dump signature stuff.

Scott

Quoted 22 lines

-----Original Message-----
From: Richard Purdie [mailto:[email protected]]
Sent: Monday, July 21, 2014 11:19 AM
To: Rifenbark, Scott M
Cc: Yang, Liezhi (Wind River); [email protected]
Subject: Re: [bitbake-devel] [PATCH 2/2] bitbake-user-manual-intro.xml:
update for dump-signatures

Quoted 4 lines · Scott M

Ok - if there is a problem or changes then let me know. I have the doc changes pushed to poky-contrib/srifenbark/bb-manual only. Richard would have to merge them from there into the upstream bitbake repository.

I modified Roberts patch a bit. Could you update the manual based on that patch? I didn't take the change for the manual you have queued for this, I'd suggest we create a new one. I did merge everything else in your bitbake manual branch.

Cheers,

Richard

#10 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

In reply to Richard Purdie
Quoted 10 lines · Richard Purdie
Quoted 4 lines · Scott M

Ok - if there is a problem or changes then let me know. I have the doc changes pushed to poky-contrib/srifenbark/bb-manual only. Richard would have to merge them from there into the upstream bitbake repository.

I modified Roberts patch a bit. Could you update the manual based on that patch? I didn't take the change for the manual you have queued for this, I'd suggest we create a new one. I did merge everything else in your bitbake manual branch.

Sorry, but I think that we need remove this:

type="choice", choices=("none", "printdiff")

after your explanations, otherwise we can't input other handlers.

I will update it later.

// Robert

Quoted 7 lines

Cheers,

Richard

#11 lore raw

Re: [PATCH 2/2] bitbake-user-manual-intro.xml: update for dump-signatures

Quoted 13 lines · Robert Yang
Quoted 10 lines · Richard Purdie
Quoted 4 lines · Scott M

Ok - if there is a problem or changes then let me know. I have the doc changes pushed to poky-contrib/srifenbark/bb-manual only. Richard would have to merge them from there into the upstream bitbake repository.

I modified Roberts patch a bit. Could you update the manual based on that patch? I didn't take the change for the manual you have queued for this, I'd suggest we create a new one. I did merge everything else in your bitbake manual branch.

Quoted 7 lines

Sorry, but I think that we need remove this:

type="choice", choices=("none", "printdiff")

after your explanations, otherwise we can't input other handlers.

I will update it later.

Right, yes, other values are/will be allowed. Thanks!

Richard

#12 lore raw
In reply to Robert Yang

Sorry, please ignore this, it should go into bitbake-devel.

// Robert

Quoted 17 lines · Robert Yang

The following changes since commit 0ed5a13f5f9478e2c22f517fb3504b738422f85c:

   python3: fix builtins imports (2014-06-30 16:36:44 +0100)

are available in the git repository at:

git://git.pokylinux.org/poky-contrib rbt/sig
http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=rbt/sig

Robert Yang (2):
bitbake: update help message for dump-signatures bitbake-user-manual-intro.xml: update for dump-signatures

  bitbake/bin/bitbake                                |    4 ++--
  .../bitbake-user-manual-intro.xml                  |   10 ++++++----
  2 files changed, 8 insertions(+), 6 deletions(-)