README
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Sun Oct 04 13:08:43 2009 +0200 (2009-10-04)
branch1.5
changeset 1566 7d22e633ed2c
parent 1546 61e8ce6419f4
child 1575 eb92c99b17cd
permissions -rw-r--r--
Tagging release 1.5.0
     1 This is the README for crosstool-NG
     2 
     3 TABLE OF CONTENT /
     4 ________________/
     5 
     6   - GETTING STARTED
     7   - CONTRIBUTING
     8     - Sending a bug report
     9     - Sending patches
    10   - CREDITS
    11   - KNOWN ISSUES
    12 
    13 
    14 GETTING STARTED /
    15 _______________/
    16 
    17 To get you started, just enter:
    18   ./configure --help
    19 
    20 You can find a (terse and WIP) documentation in docs/overview.txt.
    21 
    22 You can also point your browser to
    23   http://ymorin.is-a-geek.org/projects/crosstool
    24 
    25 
    26 CONTRIBUTING /
    27 ____________/
    28 
    29 Sending a bug report
    30 --------------------
    31 
    32 If you need to send a bug report, please send a mail with subject
    33 prefixed with "[CT_NG]" with to following destinations:
    34     TO: yann.morin.1998 (at) anciens.enib.fr
    35     CC: crossgcc (at) sourceware.org
    36 
    37 Sending patches
    38 ---------------
    39 
    40 If you want to enhance crosstool-NG, there's a to-do list in the TODO file.
    41 
    42 Patches should come with the appropriate SoB line. A SoB line is typically
    43 something like:
    44    Signed-off-by: John DOE <john.doe@somewhere.net>
    45 
    46 The SoB line is clearly described in Documentation/SubmittingPatches , section
    47 12, of your favourite Linux kernel source tree.
    48 
    49 Then you'll need to correctly configure Mercurial. There are two extensions
    50 that you may find usefull:
    51   - mq        : http://mercurial.selenic.com/wiki/MqExtension
    52   - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension
    53 
    54 Commit messages should look like (without leading pipes):
    55  |component: short, one-line description
    56  |
    57  |optional longer description
    58  |on multiple lines if needed
    59 
    60 Here is an example commit message (see revision a53a5e1d61db):
    61  |comp-libs/cloog: fix building
    62  |
    63  |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl.
    64  |For any later versions, the directory name does have the version, such as
    65  |cloog-ppl-0.15.4.
    66 
    67 Here's a typical hacking session:
    68   hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
    69   cd crosstool-ng
    70   hg qinit
    71   hg qnew -D -U -e my_first_patch
    72   *edit patch description*
    73   *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
    74   hg qref -D -e
    75   *edit patch description, serving as commit message*
    76   hg qnew -D -U -e my_second_patch
    77   *edit patch description*
    78   *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
    79   hg qref -D -e
    80   *edit patch description, serving as commit message*
    81   hg email --outgoing --intro   \
    82            --from '"Your Full NAME" <your.email (at) your.domain>'   \
    83            --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>'    \
    84            --cc 'crossgcc (at) sourceware.org'
    85   *edit introductory message*
    86   *wait for feedback*
    87   *re-send if no answer for a few days*
    88 
    89 Note: replace' (at) ' above with a plain '@'.
    90 
    91 
    92 CREDITS /
    93 _______/
    94 
    95 The people that helped are listed in docs/CREDITS. Many thanks to them! :-)
    96 
    97 
    98 KNOWN ISSUES /
    99 ____________/
   100 
   101 The list of known issues is listed in docs/known-issues.txt.
   102 
   103 Aloha!