OEDEM 2010: [RFC] useful commit message

OEDEM 2010: [RFC] useful commit message

[Paul Menzel]

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

Dear OE folks,


could you please discuss the following proposal.

I would very much like more elaborate commit messages. This is in my
opinion already demanded by the commit policy [1], but often patch
submitters, especially those not sending changes to review to the list,
since they have direct access to the repository, fail to adhere to the
policy.

The reason is, quite often I do not understand why a change was
necessary. It would very much help me, if at least the error message was
pasted to be able to compare with one’s own error messages and what
distribution and machine was used to test the recipe.

I added an item to the OEDEM wiki page too [2].


Thanks,

Paul


[1] http://wiki.openembedded.org/index.php/Commit_Policy
[2] http://wiki.openembedded.org/index.php?title=Oedem%2F2010&diff=2961&oldid=2954

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 205 bytes --]

Re: OEDEM 2010: [RFC] useful commit message

[Frans Meulenbroeks]

2010/10/29 Paul Menzel <paulepanter@users.sourceforge.net>:
> Dear OE folks,
>
>
> could you please discuss the following proposal.
>
> I would very much like more elaborate commit messages. This is in my
> opinion already demanded by the commit policy [1], but often patch
> submitters, especially those not sending changes to review to the list,
> since they have direct access to the repository, fail to adhere to the
> policy.
>
> The reason is, quite often I do not understand why a change was
> necessary. It would very much help me, if at least the error message was
> pasted to be able to compare with one’s own error messages and what
> distribution and machine was used to test the recipe.
>
> I added an item to the OEDEM wiki page too [2].
>
>
> Thanks,
>
> Paul
>
>
> [1] http://wiki.openembedded.org/index.php/Commit_Policy
> [2] http://wiki.openembedded.org/index.php?title=Oedem%2F2010&diff=2961&oldid=2954
>

It has been added to the agenda!
Thanks for bringing up this topic.

Frans

Re: OEDEM 2010: [RFC] useful commit message

[Koen Kooi]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 29-10-10 11:02, Paul Menzel wrote:
> Dear OE folks,
> 
> 
> could you please discuss the following proposal.
> 
> I would very much like more elaborate commit messages. This is in my
> opinion already demanded by the commit policy [1], but often patch
> submitters, especially those not sending changes to review to the list,
> since they have direct access to the repository, fail to adhere to the
> policy.
> 
> The reason is, quite often I do not understand why a change was
> necessary. It would very much help me, if at least the error message was
> pasted to be able to compare with one’s own error messages and what
> distribution and machine was used to test the recipe.

We discussed this at OEDEM and AIUI the TSC will make a recommendation
about it later, but in the meantime you can expand existing commit
messages with git notes:

- -----------------
GIT-NOTES(1)

NAME
       git-notes - Add/inspect commit notes

SYNOPSIS
       git notes (edit [-F <file> | -m <msg>] | show) [commit]

DESCRIPTION
       This command allows you to add notes to commit messages, without
changing the commit. To discern these notes from the message stored in
the commit object, the notes
       are indented like the message, after an unindented line saying
"Notes:".

       To disable commit notes, you have to set the config variable
core.notesRef to the empty string. Alternatively, you can set it to a
different ref, something like
       "refs/notes/bugzilla". This setting can be overridden by the
environment variable "GIT_NOTES_REF".

SUBCOMMANDS
       edit
           Edit the notes for a given commit (defaults to HEAD).

       show
           Show the notes for a given commit (defaults to HEAD).

OPTIONS
       -m <msg>
           Use the given note message (instead of prompting). If
multiple -m (or -F) options are given, their values are concatenated as
separate paragraphs.

       -F <file>
           Take the note message from the given file. Use - to read the
note message from the standard input. If multiple -F (or -m) options are
given, their values are
           concatenated as separate paragraphs.
- -----------------

It would of course be better to get it right the first time :)

regards,

Koen
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (Darwin)

iD8DBQFMzUL0MkyGM64RGpERAlfMAJsGBzO3oZ68BEvCK0QehPsvbnB4hQCgpp4d
sj+pB/5JTY1O7NJtuyMvsyU=
=DiG8
-----END PGP SIGNATURE-----

Re: OEDEM 2010: [RFC] useful commit message

[Denys Dmytriyenko]

On Sun, Oct 31, 2010 at 11:20:36AM +0100, Koen Kooi wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> On 29-10-10 11:02, Paul Menzel wrote:
> > Dear OE folks,
> > 
> > 
> > could you please discuss the following proposal.
> > 
> > I would very much like more elaborate commit messages. This is in my
> > opinion already demanded by the commit policy [1], but often patch
> > submitters, especially those not sending changes to review to the list,
> > since they have direct access to the repository, fail to adhere to the
> > policy.
> > 
> > The reason is, quite often I do not understand why a change was
> > necessary. It would very much help me, if at least the error message was
> > pasted to be able to compare with one???s own error messages and what
> > distribution and machine was used to test the recipe.
> 
> We discussed this at OEDEM and AIUI the TSC will make a recommendation
> about it later, but in the meantime you can expand existing commit
> messages with git notes:

While git-notes is relatively new (1.6.6+), it's a very useful feature. Some 
more details here:

http://progit.org/2010/08/25/notes.html

-- 
Denys

> 
> - -----------------
> GIT-NOTES(1)
> 
> NAME
>        git-notes - Add/inspect commit notes
> 
> SYNOPSIS
>        git notes (edit [-F <file> | -m <msg>] | show) [commit]
> 
> DESCRIPTION
>        This command allows you to add notes to commit messages, without
> changing the commit. To discern these notes from the message stored in
> the commit object, the notes
>        are indented like the message, after an unindented line saying
> "Notes:".
> 
>        To disable commit notes, you have to set the config variable
> core.notesRef to the empty string. Alternatively, you can set it to a
> different ref, something like
>        "refs/notes/bugzilla". This setting can be overridden by the
> environment variable "GIT_NOTES_REF".
> 
> SUBCOMMANDS
>        edit
>            Edit the notes for a given commit (defaults to HEAD).
> 
>        show
>            Show the notes for a given commit (defaults to HEAD).
> 
> OPTIONS
>        -m <msg>
>            Use the given note message (instead of prompting). If
> multiple -m (or -F) options are given, their values are concatenated as
> separate paragraphs.
> 
>        -F <file>
>            Take the note message from the given file. Use - to read the
> note message from the standard input. If multiple -F (or -m) options are
> given, their values are
>            concatenated as separate paragraphs.
> - -----------------
> 
> It would of course be better to get it right the first time :)
> 
> regards,
> 
> Koen
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.5 (Darwin)
> 
> iD8DBQFMzUL0MkyGM64RGpERAlfMAJsGBzO3oZ68BEvCK0QehPsvbnB4hQCgpp4d
> sj+pB/5JTY1O7NJtuyMvsyU=
> =DiG8
> -----END PGP SIGNATURE-----
> 
> 
> _______________________________________________
> Openembedded-devel mailing list
> Openembedded-devel@lists.openembedded.org
> http://lists.linuxtogo.org/cgi-bin/mailman/listinfo/openembedded-devel