doc: document the description line for the commit message
authorMichael Hope <michael.hope@linaro.org>
Thu Sep 29 15:16:48 2011 +1300 (2011-09-29)
changeset 2700e8d25b041de5
parent 2699 28a97cb454e2
child 2701 99de89e9acba
doc: document the description line for the commit message

Documented how to format description lines for packages patches.
Added a note on enforcing Signed-off-by lines.

Signed-off-by: Michael Hope <michael.hope@linaro.org>
[yann.morin.1998@anciens.enib.fr: further describe the desc line]
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
docs/7 - Contributing to crosstool-NG.txt
     1.1 --- a/docs/7 - Contributing to crosstool-NG.txt	Fri Oct 07 15:23:47 2011 +0200
     1.2 +++ b/docs/7 - Contributing to crosstool-NG.txt	Thu Sep 29 15:16:48 2011 +1300
     1.3 @@ -21,6 +21,32 @@
     1.4  
     1.5  If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
     1.6  
     1.7 +When updating a package, please include the category and component in the
     1.8 +start of the description. For example:
     1.9 +    cc/gcc: update to the Linaro 2011.09 release
    1.10 +
    1.11 +Here is the (mostly-complete) list of categories and components:
    1.12 +
    1.13 +    Categories  | Components
    1.14 +    ------------+-------------------------------------------------------
    1.15 +    arch        | alpha, arm, mips, powerpc...
    1.16 +    cc          | gcc
    1.17 +    binutils    | binutils, elf2flt, sstrip
    1.18 +    libc        | eglibc, uClibc, glibc, newlib, mingw, none
    1.19 +    kernel      | linux, mingw32, bare-metal
    1.20 +    debug       | dmalloc, duma, gdb, ltrace, strace
    1.21 +    complibs    | gmp, mpfr, ppl, cloog, mpc, libelf
    1.22 +    comptools   | make, m4, autoconf, automake, libtool
    1.23 +    ------------+-------------------------------------------------------
    1.24 +                | The following categories have no component-part:
    1.25 +    samples     | when adding/updating/removing a sample
    1.26 +    kconfig     | for stuff in the kconfig/ dir
    1.27 +    docs        | for changes to the documentation
    1.28 +    configure   | for changes to ./configure and/or Makefile.in
    1.29 +    config      | for stuff in config/ not covered above
    1.30 +    scripts     | for stuff in scripts/ not covered above
    1.31 +
    1.32 +
    1.33  Patches should come with the appropriate SoB line. A SoB line is typically
    1.34  something like:
    1.35     Signed-off-by: John DOE <john.doe@somewhere.net>
    1.36 @@ -28,6 +54,16 @@
    1.37  The SoB line is clearly described in Documentation/SubmittingPatches , section
    1.38  12, of your favourite Linux kernel source tree.
    1.39  
    1.40 +Add the following to your ~/.hgrc to make Mercurial check for the SoB
    1.41 +line when committing:
    1.42 +    [hooks]
    1.43 +    pretxncommit.signoff = hg log --template '{desc}\n' -r $HG_NODE \
    1.44 +        | grep -qi '^signed-off-by:'
    1.45 +
    1.46 +You can also add any of the following lines if applicable:
    1.47 +    Acked-by:
    1.48 +    Tested-by:
    1.49 +    Reviewed-by:
    1.50  
    1.51  For larger or more frequent contributions, mercurial should be used.
    1.52  There is a nice, complete and step-by-step tutorial in section 'C'.