README
changeset 1575 eb92c99b17cd
parent 1554 3b8df55987ae
child 2091 7975604aacbd
     1.1 --- a/README	Sat Oct 03 17:23:17 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