crosstool-ng/README

This is the README for crosstool-NG

TABLE OF CONTENT /
________________/

  - GETTING STARTED
  - PARTICIPATING
    - Sending a bug report
    - Sending patches
  - CREDITS
  - KNOWN ISSUES


GETTING STARTED /
_______________/

To get you started, just enter:
  ./configure --help

You can find a (terse and WIP) documentation in docs/overview.txt.

You can also point your browser to
  http://ymorin.is-a-geek.org/projects/crosstool

PARTICIPATING /
_____________/

Sending a bug report
--------------------

If you need to send a bug report, please send a mail with subject
prefixed with "[CT_NG]" with to following destinations:
    TO: yann.morin.1998 (at) anciens.enib.fr
    CC: crossgcc (at) sourceware.org

Sending patches
---------------

If you want to enhance crosstool-NG, there's a to-do list in the TODO file.

Patches should come with the appropriate SoB line. A SoB line is typically
something like:
   Signed-off-by: John DOE <john.doe@somewhere.net>

The SoB line is clearly described in Documentation/SubmittingPatches , section
12, of your favourite Linux kernel source tree.

Then you'll need to correctly configure Mercurial. There are two extensions
that you may find usefull:
  - mq        : http://mercurial.selenic.com/wiki/MqExtension
  - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension

Here's a typical hacking session:
  hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng
  cd crosstool-ng
  hg qinit
  hg qnew -D -U -e my_first_patch
  *edit patch description*
  *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
  hg qref -D -e
  *edit patch description, serving as commit message*
  hg qnew -D -U -e my_second_patch
  *edit patch description*
  *hack* *hack* *check* *fails* *hack* *hack* *check* *works*
  hg qref -D -e
  *edit patch description, serving as commit message*
  hg email --outgoing --intro   \
           --from '"Your Full NAME" <your.email (at) your.domain>'   \
           --to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>'    \
           --cc 'crossgcc (at) sourceware.org'
  *edit introductory message*
  *wait for feedback*
  *re-send if no answer for a few days*

Note: replace' (at) ' above with a plain '@'.

CREDITS /
_______/

The people that helped are listed in docs/CREDITS. Many thanks to them! :-)

KNOWN ISSUES /
____________/

The list of known issues is listed in docs/known-issues.txt.

Aloha!
Add the full crosstool-NG sources to the new repository of its own. You might just say: 'Yeah! crosstool-NG's got its own repo!". Unfortunately, that's because the previous repo got damaged beyond repair and I had no backup. That means I'm putting backups in place in the afternoon. That also means we've lost history... :-( 2007-02-24 11:00:05 +00:00			`This is the README for crosstool-NG`

Add sections to the README 2009-08-07 16:30:45 +00:00			`TABLE OF CONTENT /`
			`________________/`

			`- GETTING STARTED`
			`- PARTICIPATING`
			`- Sending a bug report`
			`- Sending patches`
			`- CREDITS`
			`- KNOWN ISSUES`


			`GETTING STARTED /`
			`_______________/`

Correctly handle the version string, defined in a single place now. Fix and update README. 2007-05-13 19:03:49 +00:00			`To get you started, just enter:`
Fix running without installing. Update README. Point help to the man page. 2007-07-01 21:21:11 +00:00			`./configure --help`
Add the full crosstool-NG sources to the new repository of its own. You might just say: 'Yeah! crosstool-NG's got its own repo!". Unfortunately, that's because the previous repo got damaged beyond repair and I had no backup. That means I'm putting backups in place in the afternoon. That also means we've lost history... :-( 2007-02-24 11:00:05 +00:00
Fix running without installing. Update README. Point help to the man page. 2007-07-01 21:21:11 +00:00			`You can find a (terse and WIP) documentation in docs/overview.txt.`
Add the full crosstool-NG sources to the new repository of its own. You might just say: 'Yeah! crosstool-NG's got its own repo!". Unfortunately, that's because the previous repo got damaged beyond repair and I had no backup. That means I'm putting backups in place in the afternoon. That also means we've lost history... :-( 2007-02-24 11:00:05 +00:00
			`You can also point your browser to`
Update the README with the new URL to the project homepage The URL for the crosstool-NG homepage has changed. Update the README accordingly. The old URL is still valid, though. 2009-08-07 15:25:20 +00:00			`http://ymorin.is-a-geek.org/projects/crosstool`
Debug facilities: - add a framework to easily add new ones - add gdb as a first debug facility - add patches for gdb After the kernel checked its installed headers, clean up the mess of .checked.* files. Reorder scripts/crosstool.sh: - dump the configuration early - renice early - get info about build system early, when setting up the environment - when in cross or native, the host tools are those of the build system, and only in this case - elapsed time calculations moved to scripts/functions Remove handling of the color: it's gone once and for all. Update tools/addToolVersion.sh: - handle debug facilities - commonalise some code - remove dead tools (cygwin, tcc) Point to my address for bug reports. 2007-05-17 16:22:51 +00:00
Add sections to the README 2009-08-07 16:30:45 +00:00			`PARTICIPATING /`
			`_____________/`

			`Sending a bug report`
			`--------------------`
Add a TODO file. -------- diffstat follows -------- /trunk/README \| 2 2 0 0 ++ /trunk/TODO \| 37 37 0 0 +++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) 2009-05-12 06:07:41 +00:00
Add sections to the README 2009-08-07 16:30:45 +00:00			`If you need to send a bug report, please send a mail with subject`
README: fix some space alignment 2009-08-28 10:09:04 +00:00			`prefixed with "[CT_NG]" with to following destinations:`
			`TO: yann.morin.1998 (at) anciens.enib.fr`
			`CC: crossgcc (at) sourceware.org`
Add sections to the README 2009-08-07 16:30:45 +00:00
			`Sending patches`
			`---------------`

			`If you want to enhance crosstool-NG, there's a to-do list in the TODO file.`
Update docs/CREDITS: ARM EABI support. Update README: point at docs/CREDITS. 2007-09-14 21:41:00 +00:00
/trunk: - README: add SoB line requirements for patches. -------- diffstat follows -------- /trunk/README \| 7 7 0 0 +++++++ 1 file changed, 7 insertions(+) 2009-05-21 13:49:15 +00:00			`Patches should come with the appropriate SoB line. A SoB line is typically`
README: fix some space alignment 2009-08-28 10:09:04 +00:00			`something like:`
Add sections to the README 2009-08-07 16:30:45 +00:00			`Signed-off-by: John DOE <john.doe@somewhere.net>`
/trunk: - README: add SoB line requirements for patches. -------- diffstat follows -------- /trunk/README \| 7 7 0 0 +++++++ 1 file changed, 7 insertions(+) 2009-05-21 13:49:15 +00:00
			`The SoB line is clearly described in Documentation/SubmittingPatches , section`
			`12, of your favourite Linux kernel source tree.`

Update README on how to send proper patches Add a few lines of explanations on how to correctly setup and use Mercurial to send proper patches. 2009-08-07 16:24:25 +00:00			`Then you'll need to correctly configure Mercurial. There are two extensions`
			`that you may find usefull:`
			`- mq : http://mercurial.selenic.com/wiki/MqExtension`
			`- patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension`

			`Here's a typical hacking session:`
			`hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng`
			`cd crosstool-ng`
			`hg qinit`
			`hg qnew -D -U -e my_first_patch`
			`edit patch description`
			`hack hack check fails hack hack check works`
			`hg qref -D -e`
			`edit patch description, serving as commit message`
			`hg qnew -D -U -e my_second_patch`
			`edit patch description`
			`hack hack check fails hack hack check works`
			`hg qref -D -e`
			`edit patch description, serving as commit message`
			`hg email --outgoing --intro \`
			`--from '"Your Full NAME" <your.email (at) your.domain>' \`
			`--to '"Yann E. MORIN" <yann.morin.1998 (at) anciens.enib.fr>' \`
			`--cc 'crossgcc (at) sourceware.org'`
			`edit introductory message`
			`wait for feedback`
			`re-send if no answer for a few days`

			`Note: replace' (at) ' above with a plain '@'.`

Add sections to the README 2009-08-07 16:30:45 +00:00			`CREDITS /`
			`_______/`

Update docs/CREDITS: ARM EABI support. Update README: point at docs/CREDITS. 2007-09-14 21:41:00 +00:00			`The people that helped are listed in docs/CREDITS. Many thanks to them! :-)`
Fix running without installing. Update README. Point help to the man page. 2007-07-01 21:21:11 +00:00
Add sections to the README 2009-08-07 16:30:45 +00:00			`KNOWN ISSUES /`
			`____________/`

Typoes. /trunk/README \| 2 1 1 0 +- /trunk/config/kernel.in \| 2 1 1 0 +- 2 files changed, 2 insertions(+), 2 deletions(-) 2008-10-06 20:13:05 +00:00			`The list of known issues is listed in docs/known-issues.txt.`
Update README to point to docs/known-issues.txt. /trunk/README \| 2 2 0 0 ++ 1 file changed, 2 insertions(+) 2008-08-30 15:24:28 +00:00
Fix running without installing. Update README. Point help to the man page. 2007-07-01 21:21:11 +00:00			`Aloha!`