ExternalVendorCode/crosstool-ng
1
0
Fork 0
mirror of https://github.com/crosstool-ng/crosstool-ng.git synced 2025-02-18 16:20:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: document the description line for the commit message

Browse Source 
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>
This commit is contained in:
Yann E. MORIN" 2011-09-29 15:16:48 +13:00 committed by Michael Hope
parent 85a85d3cc7
commit 4ddbf5c7dc
1 changed files with 36 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/7 - Contributing to crosstool-NG.txt
View File

@ -21,6 +21,32 @@ Sending patches |
If you want to enhance crosstool-NG, there's a to-do list in the TODO file. If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
When updating a package, please include the category and component in the
start of the description. For example:
cc/gcc: update to the Linaro 2011.09 release
Here is the (mostly-complete) list of categories and components:
Categories | Components
------------+-------------------------------------------------------
arch | alpha, arm, mips, powerpc...
cc | gcc
binutils | binutils, elf2flt, sstrip
libc | eglibc, uClibc, glibc, newlib, mingw, none
kernel | linux, mingw32, bare-metal
debug | dmalloc, duma, gdb, ltrace, strace
complibs | gmp, mpfr, ppl, cloog, mpc, libelf
comptools | make, m4, autoconf, automake, libtool
------------+-------------------------------------------------------
| The following categories have no component-part:
samples | when adding/updating/removing a sample
kconfig | for stuff in the kconfig/ dir
docs | for changes to the documentation
configure | for changes to ./configure and/or Makefile.in
config | for stuff in config/ not covered above
scripts | for stuff in scripts/ not covered above
Patches should come with the appropriate SoB line. A SoB line is typically Patches should come with the appropriate SoB line. A SoB line is typically
something like: something like:
Signed-off-by: John DOE <john.doe@somewhere.net> Signed-off-by: John DOE <john.doe@somewhere.net>
@ -28,6 +54,16 @@ something like:
The SoB line is clearly described in Documentation/SubmittingPatches , section The SoB line is clearly described in Documentation/SubmittingPatches , section
12, of your favourite Linux kernel source tree. 12, of your favourite Linux kernel source tree.
Add the following to your ~/.hgrc to make Mercurial check for the SoB
line when committing:
[hooks]
pretxncommit.signoff = hg log --template '{desc}\n' -r $HG_NODE \
| grep -qi '^signed-off-by:'
You can also add any of the following lines if applicable:
Acked-by:
Tested-by:
Reviewed-by:
For larger or more frequent contributions, mercurial should be used. For larger or more frequent contributions, mercurial should be used.
There is a nice, complete and step-by-step tutorial in section 'C'. There is a nice, complete and step-by-step tutorial in section 'C'.