README
author "Yann E. MORIN" <yann.morin.1998@anciens.enib.fr>
Fri Sep 04 17:27:16 2009 +0200 (2009-09-04)
changeset 1512 439a6b292917
parent 1466 1bacd35b57e6
child 1546 61e8ce6419f4
permissions -rw-r--r--
TODO: update

Add TODO list for m4, autoconf, automake and libtool.
Building our own versions would remove burden from the users
who have older versions on their distributions, and are not
ready/able/allowed to upgrade.
     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 PARTICIPATING /
    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 Here's a typical hacking session:
    54   hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
    55   cd crosstool-ng
    56   hg qinit
    57   hg qnew -D -U -e my_first_patch
    58   *edit patch description*
    59   *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
    60   hg qref -D -e
    61   *edit patch description, serving as commit message*
    62   hg qnew -D -U -e my_second_patch
    63   *edit patch description*
    64   *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
    65   hg qref -D -e
    66   *edit patch description, serving as commit message*
    67   hg email --outgoing --intro   \
    68            --from '"Your Full NAME" <your.email (at) your.domain>'   \
    69            --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>'    \
    70            --cc 'crossgcc (at) sourceware.org'
    71   *edit introductory message*
    72   *wait for feedback*
    73   *re-send if no answer for a few days*
    74 
    75 Note: replace' (at) ' above with a plain '@'.
    76 
    77 CREDITS /
    78 _______/
    79 
    80 The people that helped are listed in docs/CREDITS. Many thanks to them! :-)
    81 
    82 KNOWN ISSUES /
    83 ____________/
    84 
    85 The list of known issues is listed in docs/known-issues.txt.
    86 
    87 Aloha!