1.1 --- a/docs/overview.txt	Sat Oct 10 11:24:31 2009 +0200
     1.2 +++ b/docs/overview.txt	Sat Oct 10 12:55:17 2009 +0200
     1.3 @@ -30,6 +30,9 @@
     1.4    The 'populate' script
     1.5  Toolchain types
     1.6    Seemingly-native toolchains
     1.7 +Contributing
     1.8 +  Sending a bug report
     1.9 +  Sending patches
    1.10  Internals
    1.11    Makefile front-end
    1.12    Kconfig parser
    1.13 @@ -157,8 +160,7 @@
    1.14  See below for complete usage.
    1.15  
    1.16  Now, provided you used a clone of the repository, you can send me your changes.
    1.17 -See the file README, at the top of crosstool-NG source, for how to submit
    1.18 -changees.
    1.19 +See the section titled CONTRIBUTING, below, for how to submit changees.
    1.20  
    1.21  Preparing for packaging |
    1.22  ------------------------+
    1.23 @@ -597,6 +599,74 @@
    1.24  only with glibc (and eglibc?) starting with version 2.7.
    1.25  
    1.26  
    1.27 +________________
    1.28 +               /
    1.29 +Contributing  /
    1.30 +_____________/
    1.31 +
    1.32 +Sending a bug report |
    1.33 +---------------------+
    1.34 +
    1.35 +If you need to send a bug report, please send a mail with subject
    1.36 +prefixed with "[CT_NG]" with to following destinations:
    1.37 +    TO: yann.morin.1998 (at) anciens.enib.fr
    1.38 +    CC: crossgcc (at) sourceware.org
    1.39 +
    1.40 +Sending patches |
    1.41 +----------------+
    1.42 +
    1.43 +If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
    1.44 +
    1.45 +Patches should come with the appropriate SoB line. A SoB line is typically
    1.46 +something like:
    1.47 +   Signed-off-by: John DOE <john.doe@somewhere.net>
    1.48 +
    1.49 +The SoB line is clearly described in Documentation/SubmittingPatches , section
    1.50 +12, of your favourite Linux kernel source tree.
    1.51 +
    1.52 +Then you'll need to correctly configure Mercurial. There are two extensions
    1.53 +that you may find usefull:
    1.54 +  - mq        : http://mercurial.selenic.com/wiki/MqExtension
    1.55 +  - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
    1.56 +
    1.57 +Commit messages should look like (without leading pipes):
    1.58 + |component: short, one-line description
    1.59 + |
    1.60 + |optional longer description
    1.61 + |on multiple lines if needed
    1.62 +
    1.63 +Here is an example commit message (see revision a53a5e1d61db):
    1.64 + |comp-libs/cloog: fix building
    1.65 + |
    1.66 + |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
    1.67 + |For any later versions, the directory name does have the version, such as
    1.68 + |cloog-ppl-0.15.4.
    1.69 +
    1.70 +Here's a typical hacking session:
    1.71 +  hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
    1.72 +  cd crosstool-ng
    1.73 +  hg qinit
    1.74 +  hg qnew -D -U -e my_first_patch
    1.75 +  *edit patch description*
    1.76 +  *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
    1.77 +  hg qref -D -e
    1.78 +  *edit patch description, serving as commit message*
    1.79 +  hg qnew -D -U -e my_second_patch
    1.80 +  *edit patch description*
    1.81 +  *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
    1.82 +  hg qref -D -e
    1.83 +  *edit patch description, serving as commit message*
    1.84 +  hg email --outgoing --intro   \
    1.85 +           --from '"Your Full NAME" <your.email (at) your.domain>'   \
    1.86 +           --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>'    \
    1.87 +           --cc 'crossgcc (at) sourceware.org'
    1.88 +  *edit introductory message*
    1.89 +  *wait for feedback*
    1.90 +  *re-send if no answer for a few days*
    1.91 +
    1.92 +Note: replace '(at)' above with a plain '@'.
    1.93 +
    1.94 +
    1.95  _____________
    1.96              /
    1.97  Internals  /