summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorYann E. MORIN" <yann.morin.1998@anciens.enib.fr>2009-10-10 10:55:17 (GMT)
committerYann E. MORIN" <yann.morin.1998@anciens.enib.fr>2009-10-10 10:55:17 (GMT)
commit632d59babdc692e6e669310a7564777ce59bdb5d (patch)
tree3af876fb4ca4b24e3bbbcbeeb99198ca3e0edeba /README
parent3902827e9fa5f231baf65596b8e6e40296cd7b61 (diff)
docs: move the "contributing" section to overview.txt
Diffstat (limited to 'README')
-rw-r--r--README83
1 files changed, 12 insertions, 71 deletions
diff --git a/README b/README
index 560d3d0..b841a7f 100644
--- a/README
+++ b/README
@@ -4,9 +4,6 @@ TABLE OF CONTENT /
________________/
- GETTING STARTED
- - CONTRIBUTING
- - Sending a bug report
- - Sending patches
- CREDITS
- KNOWN ISSUES
@@ -18,77 +15,21 @@ To get you started, just enter:
./configure --help
You can find a (terse and WIP) documentation in docs/overview.txt.
-
-You can also point your browser to
+Here's a summary of what you'll find in there:
+ Introduction
+ History
+ Installing crosstool-NG
+ Configuring crosstool-NG
+ Running crosstool-NG
+ Using the toolchain
+ Toolchain types
+ Contributing
+ Internals
+
+You can also point your browser at:
http://ymorin.is-a-geek.org/projects/crosstool
-CONTRIBUTING /
-____________/
-
-Sending a bug report
---------------------
-
-If you need to send a bug report, please send a mail with subject
-prefixed with "[CT_NG]" with to following destinations:
- TO: yann.morin.1998 (at) anciens.enib.fr
- CC: crossgcc (at) sourceware.org
-
-Sending patches
----------------
-
-If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
-
-Patches should come with the appropriate SoB line. A SoB line is typically
-something like:
- Signed-off-by: John DOE <john.doe@somewhere.net>
-
-The SoB line is clearly described in Documentation/SubmittingPatches , section
-12, of your favourite Linux kernel source tree.
-
-Then you'll need to correctly configure Mercurial. There are two extensions
-that you may find usefull:
- - mq : http://mercurial.selenic.com/wiki/MqExtension
- - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
-
-Commit messages should look like (without leading pipes):
- |component: short, one-line description
- |
- |optional longer description
- |on multiple lines if needed
-
-Here is an example commit message (see revision a53a5e1d61db):
- |comp-libs/cloog: fix building
- |
- |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
- |For any later versions, the directory name does have the version, such as
- |cloog-ppl-0.15.4.
-
-Here's a typical hacking session:
- hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
- cd crosstool-ng
- hg qinit
- hg qnew -D -U -e my_first_patch
- *edit patch description*
- *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
- hg qref -D -e
- *edit patch description, serving as commit message*
- hg qnew -D -U -e my_second_patch
- *edit patch description*
- *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
- hg qref -D -e
- *edit patch description, serving as commit message*
- hg email --outgoing --intro \
- --from '"Your Full NAME" <your.email (at) your.domain>' \
- --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>' \
- --cc 'crossgcc (at) sourceware.org'
- *edit introductory message*
- *wait for feedback*
- *re-send if no answer for a few days*
-
-Note: replace' (at) ' above with a plain '@'.
-
-
CREDITS /
_______/