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