yann@1: This is the README for crosstool-NG
yann@1: 
yann@1465: TABLE OF CONTENT /
yann@1465: ________________/
yann@1465: 
yann@1465:   - GETTING STARTED
yann@1554:   - CONTRIBUTING
yann@1465:     - Sending a bug report
yann@1465:     - Sending patches
yann@1465:   - CREDITS
yann@1465:   - KNOWN ISSUES
yann@1465: 
yann@1465: 
yann@1465: GETTING STARTED /
yann@1465: _______________/
yann@1465: 
yann@88: To get you started, just enter:
yann@185:   ./configure --help
yann@1: 
yann@185: You can find a (terse and WIP) documentation in docs/overview.txt.
yann@1: 
yann@1: You can also point your browser to
yann@1463:   http://ymorin.is-a-geek.org/projects/crosstool
yann@96: 
yann@1554: 
yann@1546: CONTRIBUTING /
yann@1546: ____________/
yann@1465: 
yann@1465: Sending a bug report
yann@1465: --------------------
yann@1465: 
yann@1465: If you need to send a bug report, please send a mail with subject
yann@1490: prefixed with "[CT_NG]" with to following destinations:
yann@1490:     TO: yann.morin.1998 (at) anciens.enib.fr
yann@1490:     CC: crossgcc (at) sourceware.org
yann@1465: 
yann@1465: Sending patches
yann@1465: ---------------
yann@1465: 
yann@1335: If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
yann@1335: 
yann@1348: Patches should come with the appropriate SoB line. A SoB line is typically
yann@1490: something like:
yann@1465:    Signed-off-by: John DOE <john.doe@somewhere.net>
yann@1348: 
yann@1348: The SoB line is clearly described in Documentation/SubmittingPatches , section
yann@1348: 12, of your favourite Linux kernel source tree.
yann@1348: 
yann@1466: Then you'll need to correctly configure Mercurial. There are two extensions
yann@1466: that you may find usefull:
yann@1466:   - mq        : http://mercurial.selenic.com/wiki/MqExtension
yann@1466:   - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
yann@1466: 
yann@1546: Commit messages should look like (without leading pipes):
yann@1546:  |component: short, one-line description
yann@1546:  |
yann@1546:  |optional longer description
yann@1546:  |on multiple lines if needed
yann@1546: 
yann@1546: Here is an example commit message (see revision a53a5e1d61db):
yann@1546:  |comp-libs/cloog: fix building
yann@1546:  |
yann@1546:  |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
yann@1546:  |For any later versions, the directory name does have the version, such as
yann@1546:  |cloog-ppl-0.15.4.
yann@1546: 
yann@1466: Here's a typical hacking session:
yann@1466:   hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
yann@1466:   cd crosstool-ng
yann@1466:   hg qinit
yann@1466:   hg qnew -D -U -e my_first_patch
yann@1466:   *edit patch description*
yann@1466:   *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
yann@1466:   hg qref -D -e
yann@1466:   *edit patch description, serving as commit message*
yann@1466:   hg qnew -D -U -e my_second_patch
yann@1466:   *edit patch description*
yann@1466:   *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
yann@1466:   hg qref -D -e
yann@1466:   *edit patch description, serving as commit message*
yann@1466:   hg email --outgoing --intro   \
yann@1466:            --from '"Your Full NAME" <your.email (at) your.domain>'   \
yann@1466:            --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>'    \
yann@1466:            --cc 'crossgcc (at) sourceware.org'
yann@1466:   *edit introductory message*
yann@1466:   *wait for feedback*
yann@1466:   *re-send if no answer for a few days*
yann@1466: 
yann@1466: Note: replace' (at) ' above with a plain '@'.
yann@1466: 
yann@1554: 
yann@1465: CREDITS /
yann@1465: _______/
yann@1465: 
yann@386: The people that helped are listed in docs/CREDITS. Many thanks to them! :-)
yann@185: 
yann@1554: 
yann@1465: KNOWN ISSUES /
yann@1465: ____________/
yann@1465: 
yann@908: The list of known issues is listed in docs/known-issues.txt.
yann@817: 
yann@185: Aloha!