1.1 --- a/README Sat Oct 10 11:24:31 2009 +0200
1.2 +++ b/README Sat Oct 10 12:55:17 2009 +0200
1.3 @@ -4,9 +4,6 @@
1.4 ________________/
1.5
1.6 - GETTING STARTED
1.7 - - CONTRIBUTING
1.8 - - Sending a bug report
1.9 - - Sending patches
1.10 - CREDITS
1.11 - KNOWN ISSUES
1.12
1.13 @@ -18,77 +15,21 @@
1.14 ./configure --help
1.15
1.16 You can find a (terse and WIP) documentation in docs/overview.txt.
1.17 +Here's a summary of what you'll find in there:
1.18 + Introduction
1.19 + History
1.20 + Installing crosstool-NG
1.21 + Configuring crosstool-NG
1.22 + Running crosstool-NG
1.23 + Using the toolchain
1.24 + Toolchain types
1.25 + Contributing
1.26 + Internals
1.27
1.28 -You can also point your browser to
1.29 +You can also point your browser at:
1.30 http://ymorin.is-a-geek.org/projects/crosstool
1.31
1.32
1.33 -CONTRIBUTING /
1.34 -____________/
1.35 -
1.36 -Sending a bug report
1.37 ---------------------
1.38 -
1.39 -If you need to send a bug report, please send a mail with subject
1.40 -prefixed with "[CT_NG]" with to following destinations:
1.41 - TO: yann.morin.1998 (at) anciens.enib.fr
1.42 - CC: crossgcc (at) sourceware.org
1.43 -
1.44 -Sending patches
1.45 ----------------
1.46 -
1.47 -If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
1.48 -
1.49 -Patches should come with the appropriate SoB line. A SoB line is typically
1.50 -something like:
1.51 - Signed-off-by: John DOE <john.doe@somewhere.net>
1.52 -
1.53 -The SoB line is clearly described in Documentation/SubmittingPatches , section
1.54 -12, of your favourite Linux kernel source tree.
1.55 -
1.56 -Then you'll need to correctly configure Mercurial. There are two extensions
1.57 -that you may find usefull:
1.58 - - mq : http://mercurial.selenic.com/wiki/MqExtension
1.59 - - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
1.60 -
1.61 -Commit messages should look like (without leading pipes):
1.62 - |component: short, one-line description
1.63 - |
1.64 - |optional longer description
1.65 - |on multiple lines if needed
1.66 -
1.67 -Here is an example commit message (see revision a53a5e1d61db):
1.68 - |comp-libs/cloog: fix building
1.69 - |
1.70 - |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
1.71 - |For any later versions, the directory name does have the version, such as
1.72 - |cloog-ppl-0.15.4.
1.73 -
1.74 -Here's a typical hacking session:
1.75 - hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
1.76 - cd crosstool-ng
1.77 - hg qinit
1.78 - hg qnew -D -U -e my_first_patch
1.79 - *edit patch description*
1.80 - *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
1.81 - hg qref -D -e
1.82 - *edit patch description, serving as commit message*
1.83 - hg qnew -D -U -e my_second_patch
1.84 - *edit patch description*
1.85 - *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
1.86 - hg qref -D -e
1.87 - *edit patch description, serving as commit message*
1.88 - hg email --outgoing --intro \
1.89 - --from '"Your Full NAME" <your.email (at) your.domain>' \
1.90 - --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>' \
1.91 - --cc 'crossgcc (at) sourceware.org'
1.92 - *edit introductory message*
1.93 - *wait for feedback*
1.94 - *re-send if no answer for a few days*
1.95 -
1.96 -Note: replace' (at) ' above with a plain '@'.
1.97 -
1.98 -
1.99 CREDITS /
1.100 _______/
1.101
2.1 --- a/docs/overview.txt Sat Oct 10 11:24:31 2009 +0200
2.2 +++ b/docs/overview.txt Sat Oct 10 12:55:17 2009 +0200
2.3 @@ -30,6 +30,9 @@
2.4 The 'populate' script
2.5 Toolchain types
2.6 Seemingly-native toolchains
2.7 +Contributing
2.8 + Sending a bug report
2.9 + Sending patches
2.10 Internals
2.11 Makefile front-end
2.12 Kconfig parser
2.13 @@ -157,8 +160,7 @@
2.14 See below for complete usage.
2.15
2.16 Now, provided you used a clone of the repository, you can send me your changes.
2.17 -See the file README, at the top of crosstool-NG source, for how to submit
2.18 -changees.
2.19 +See the section titled CONTRIBUTING, below, for how to submit changees.
2.20
2.21 Preparing for packaging |
2.22 ------------------------+
2.23 @@ -597,6 +599,74 @@
2.24 only with glibc (and eglibc?) starting with version 2.7.
2.25
2.26
2.27 +________________
2.28 + /
2.29 +Contributing /
2.30 +_____________/
2.31 +
2.32 +Sending a bug report |
2.33 +---------------------+
2.34 +
2.35 +If you need to send a bug report, please send a mail with subject
2.36 +prefixed with "[CT_NG]" with to following destinations:
2.37 + TO: yann.morin.1998 (at) anciens.enib.fr
2.38 + CC: crossgcc (at) sourceware.org
2.39 +
2.40 +Sending patches |
2.41 +----------------+
2.42 +
2.43 +If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
2.44 +
2.45 +Patches should come with the appropriate SoB line. A SoB line is typically
2.46 +something like:
2.47 + Signed-off-by: John DOE <john.doe@somewhere.net>
2.48 +
2.49 +The SoB line is clearly described in Documentation/SubmittingPatches , section
2.50 +12, of your favourite Linux kernel source tree.
2.51 +
2.52 +Then you'll need to correctly configure Mercurial. There are two extensions
2.53 +that you may find usefull:
2.54 + - mq : http://mercurial.selenic.com/wiki/MqExtension
2.55 + - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
2.56 +
2.57 +Commit messages should look like (without leading pipes):
2.58 + |component: short, one-line description
2.59 + |
2.60 + |optional longer description
2.61 + |on multiple lines if needed
2.62 +
2.63 +Here is an example commit message (see revision a53a5e1d61db):
2.64 + |comp-libs/cloog: fix building
2.65 + |
2.66 + |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
2.67 + |For any later versions, the directory name does have the version, such as
2.68 + |cloog-ppl-0.15.4.
2.69 +
2.70 +Here's a typical hacking session:
2.71 + hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
2.72 + cd crosstool-ng
2.73 + hg qinit
2.74 + hg qnew -D -U -e my_first_patch
2.75 + *edit patch description*
2.76 + *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
2.77 + hg qref -D -e
2.78 + *edit patch description, serving as commit message*
2.79 + hg qnew -D -U -e my_second_patch
2.80 + *edit patch description*
2.81 + *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
2.82 + hg qref -D -e
2.83 + *edit patch description, serving as commit message*
2.84 + hg email --outgoing --intro \
2.85 + --from '"Your Full NAME" <your.email (at) your.domain>' \
2.86 + --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>' \
2.87 + --cc 'crossgcc (at) sourceware.org'
2.88 + *edit introductory message*
2.89 + *wait for feedback*
2.90 + *re-send if no answer for a few days*
2.91 +
2.92 +Note: replace '(at)' above with a plain '@'.
2.93 +
2.94 +
2.95 _____________
2.96 /
2.97 Internals /