[PATCH] clarify wording

[PATCH] clarify wording

[Trevor Woerner]

From: Trevor Woerner <twoerner@gmail.com>

The '-s' option shows (input) recipes, not (built/output) packages. Clarify
the help wording for this option so it is consistent.

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
 bin/bitbake |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/bin/bitbake b/bin/bitbake
index 0b4f556..ed2ff06 100755
--- a/bin/bitbake
+++ b/bin/bitbake
@@ -142,7 +142,7 @@ Default BBFILES are the .bb files in the current directory.""")
     parser.add_option("-p", "--parse-only", help = "quit after parsing the BB files (developers only)",
                action = "store_true", dest = "parse_only", default = False)
 
-    parser.add_option("-s", "--show-versions", help = "show current and preferred versions of all packages",
+    parser.add_option("-s", "--show-versions", help = "show current and preferred versions of all recipes",
                action = "store_true", dest = "show_versions", default = False)
 
     parser.add_option("-e", "--environment", help = "show the global or per-package environment (this is what used to be bbread)",
-- 
1.7.10.GIT

Re: [PATCH] clarify wording

[Andrei Gherzan]

[-- Attachment #1: Type: text/plain, Size: 1631 bytes --]

Modify the commit subject. to include what you are changing. In your case
the subject should be something like:
"bitbake: Clarify wording"

On Fri, Aug 24, 2012 at 3:22 AM, Trevor Woerner <twoerner@gmail.com> wrote:

> From: Trevor Woerner <twoerner@gmail.com>
>
> The '-s' option shows (input) recipes, not (built/output) packages. Clarify
> the help wording for this option so it is consistent.
>
> Signed-off-by: Trevor Woerner <twoerner@gmail.com>
> ---
>  bin/bitbake |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/bin/bitbake b/bin/bitbake
> index 0b4f556..ed2ff06 100755
> --- a/bin/bitbake
> +++ b/bin/bitbake
> @@ -142,7 +142,7 @@ Default BBFILES are the .bb files in the current
> directory.""")
>      parser.add_option("-p", "--parse-only", help = "quit after parsing
> the BB files (developers only)",
>                 action = "store_true", dest = "parse_only", default =
> False)
>
> -    parser.add_option("-s", "--show-versions", help = "show current and
> preferred versions of all packages",
> +    parser.add_option("-s", "--show-versions", help = "show current and
> preferred versions of all recipes",
>                 action = "store_true", dest = "show_versions", default =
> False)
>
>      parser.add_option("-e", "--environment", help = "show the global or
> per-package environment (this is what used to be bbread)",
> --
> 1.7.10.GIT
>
>
> _______________________________________________
> bitbake-devel mailing list
> bitbake-devel@lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/bitbake-devel
>

[-- Attachment #2: Type: text/html, Size: 2507 bytes --]

Re: [PATCH] clarify wording

[Trevor Woerner]

On Fri, Aug 24, 2012 at 5:19 PM, Andrei Gherzan <andrei@gherzan.ro> wrote:
> Modify the commit subject. to include what you are changing. In your case
> the subject should be something like:
> "bitbake: Clarify wording"

Sorry about that, thanks for the feedback. I'll send in a new patch
for consideration.

Re: [PATCH] clarify wording

[Andrei Gherzan]

[-- Attachment #1: Type: text/plain, Size: 455 bytes --]

On Sat, Aug 25, 2012 at 12:35 AM, Trevor Woerner <twoerner@gmail.com> wrote:

> On Fri, Aug 24, 2012 at 5:19 PM, Andrei Gherzan <andrei@gherzan.ro> wrote:
> > Modify the commit subject. to include what you are changing. In your case
> > the subject should be something like:
> > "bitbake: Clarify wording"
>
> Sorry about that, thanks for the feedback. I'll send in a new patch
> for consideration.
>

No problem. Keep up the good work!

ag

[-- Attachment #2: Type: text/html, Size: 805 bytes --]

Re: [PATCH] clarify wording

[Chris Larson]

On Fri, Aug 24, 2012 at 2:35 PM, Trevor Woerner <twoerner@gmail.com> wrote:
> On Fri, Aug 24, 2012 at 5:19 PM, Andrei Gherzan <andrei@gherzan.ro> wrote:
>> Modify the commit subject. to include what you are changing. In your case
>> the subject should be something like:
>> "bitbake: Clarify wording"
>
> Sorry about that, thanks for the feedback. I'll send in a new patch
> for consideration.

No, this is wrong. When committing to the bitbake repository, there's
no need to prefix it with 'bitbake:'. You should mention what/where
you're clarifying, however. E.g. "clarify wording in help output for
-s"
-- 
Christopher Larson
clarson at kergoth dot com
Founder - BitBake, OpenEmbedded, OpenZaurus
Maintainer - Tslib
Senior Software Engineer, Mentor Graphics

Re: [PATCH] clarify wording

[Trevor Woerner]

On Fri, Aug 24, 2012 at 11:57 PM, Chris Larson <clarson@kergoth.com> wrote:
> No, this is wrong. When committing to the bitbake repository, there's
> no need to prefix it with 'bitbake:'.

I am new to bitbake-devel, but looking through several of the more
recent commits would indicate the majority of them do have some sort
of location identifier in the subject, some of which are just
"bitbake:". One (e0f91faf195be63803d39fb42fcd115ad558c79f) even has
"bin/bitbake:"; maybe I should use this for my patch?

> You should mention what/where
> you're clarifying, however. E.g. "clarify wording in help output for
> -s"

Okay.

Re: [PATCH] clarify wording

[Chris Larson]

On Sat, Aug 25, 2012 at 3:15 AM, Andrei Gherzan <andrei@gherzan.ro> wrote:
>> No, this is wrong. When committing to the bitbake repository, there's
>> no need to prefix it with 'bitbake:'. You should mention what/where
>> you're clarifying, however. E.g. "clarify wording in help output for
>> -s"
>
> Yes i'm right. When suggesting for adding "bitbake:" i wasn't refering to
> the repo. I was talking about "what is changed". And that is the bitbake
> script. The general format is "what: Short log".
>
> Here are some examples.
> bitbake: data-smart: rename the 'content' internal variable to '_content'
> bitbake: Hob wizard-like reorganization

Wrong. Inside the bitbake repository, it shouldn't and needn't be
prefixed with 'bitbake:' unless necessary due to it coming from poky.
Perhaps the only git changelog you read is inside the poky repository,
but the rest of us pay more attention.
-- 
Christopher Larson
clarson at kergoth dot com
Founder - BitBake, OpenEmbedded, OpenZaurus
Maintainer - Tslib
Senior Software Engineer, Mentor Graphics

Re: [PATCH] clarify wording

[Andrei Gherzan]

[-- Attachment #1: Type: text/plain, Size: 1141 bytes --]

On Sun, Aug 26, 2012 at 12:00 AM, Chris Larson <clarson@kergoth.com> wrote:

> On Sat, Aug 25, 2012 at 3:15 AM, Andrei Gherzan <andrei@gherzan.ro> wrote:
> >> No, this is wrong. When committing to the bitbake repository, there's
> >> no need to prefix it with 'bitbake:'. You should mention what/where
> >> you're clarifying, however. E.g. "clarify wording in help output for
> >> -s"
> >
> > Yes i'm right. When suggesting for adding "bitbake:" i wasn't refering to
> > the repo. I was talking about "what is changed". And that is the bitbake
> > script. The general format is "what: Short log".
> >
> > Here are some examples.
> > bitbake: data-smart: rename the 'content' internal variable to '_content'
> > bitbake: Hob wizard-like reorganization
>
> Wrong. Inside the bitbake repository, it shouldn't and needn't be
> prefixed with 'bitbake:' unless necessary due to it coming from poky.
> Perhaps the only git changelog you read is inside the poky repository,
> but the rest of us pay more attention.
>
>
Ok. I see your point. And you are right. I was talking inside yocto. Thank
you for clarifying this.

ag

[-- Attachment #2: Type: text/html, Size: 1633 bytes --]

Re: [PATCH] clarify wording

[Richard Purdie]

On Sat, 2012-08-25 at 06:43 -0400, Trevor Woerner wrote:
> On Fri, Aug 24, 2012 at 11:57 PM, Chris Larson <clarson@kergoth.com> wrote:
> > No, this is wrong. When committing to the bitbake repository, there's
> > no need to prefix it with 'bitbake:'.
> 
> I am new to bitbake-devel, but looking through several of the more
> recent commits would indicate the majority of them do have some sort
> of location identifier in the subject, some of which are just
> "bitbake:". One (e0f91faf195be63803d39fb42fcd115ad558c79f) even has
> "bin/bitbake:"; maybe I should use this for my patch?

I think in this case bin/bitbake: is the best prefix. The idea is it
gives a rough idea what changed and clearly in this case that is quite a
good summary.

Since this is such a simple patch, I've tweaked it and applied it. Also
in future please include a Signed-off-by: line.

Cheers,

Richard