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