From e0ec8eda63a75cadd8e3ac943f5924b8dbe8f01a Mon Sep 17 00:00:00 2001 From: "Yann E. MORIN\"" Date: Sun, 27 Sep 2009 12:03:48 +0200 Subject: readme: document patch description --- README | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'README') diff --git a/README b/README index 97be3691..4fe8d882 100644 --- a/README +++ b/README @@ -22,8 +22,8 @@ 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 / -_____________/ +CONTRIBUTING / +____________/ Sending a bug report -------------------- @@ -50,6 +50,19 @@ that you may find usefull: - mq : http://mercurial.selenic.com/wiki/MqExtension - patchbomb : http://mercurial.selenic.com/wiki/PatchbombExtension +Commit messages should look like (without leading pipes): + |component: short, one-line description + | + |optional longer description + |on multiple lines if needed + +Here is an example commit message (see revision a53a5e1d61db): + |comp-libs/cloog: fix building + | + |For CLooG/PPL 0.15.3, the directory name was simply cloog-ppl. + |For any later versions, the directory name does have the version, such as + |cloog-ppl-0.15.4. + Here's a typical hacking session: hg clone http://ymorin.is-a-geek.org/hg/crosstool-ng crosstool-ng cd crosstool-ng -- cgit v1.2.3 From 1e1f247accfb508c7094294627f6f0b765b2da18 Mon Sep 17 00:00:00 2001 From: "Yann E. MORIN\"" Date: Sat, 3 Oct 2009 17:23:17 +0200 Subject: doc: update documentation, mostly eye-candy --- README | 5 ++++- docs/overview.txt | 9 ++++----- 2 files changed, 8 insertions(+), 6 deletions(-) (limited to 'README') diff --git a/README b/README index 4fe8d882..560d3d06 100644 --- a/README +++ b/README @@ -4,7 +4,7 @@ TABLE OF CONTENT / ________________/ - GETTING STARTED - - PARTICIPATING + - CONTRIBUTING - Sending a bug report - Sending patches - CREDITS @@ -22,6 +22,7 @@ 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 + CONTRIBUTING / ____________/ @@ -87,11 +88,13 @@ Here's a typical hacking session: Note: replace' (at) ' above with a plain '@'. + CREDITS / _______/ The people that helped are listed in docs/CREDITS. Many thanks to them! :-) + KNOWN ISSUES / ____________/ diff --git a/docs/overview.txt b/docs/overview.txt index 8d9a6f04..61b4cba5 100644 --- a/docs/overview.txt +++ b/docs/overview.txt @@ -27,6 +27,7 @@ Running crosstool-NG Note on // jobs Tools wrapper Using the toolchain + The 'populate' script Toolchain types Seemingly-native toolchains Internals @@ -155,11 +156,9 @@ Stay in the directory holding the sources, and run: See below for complete usage. -Now, provided you checked-out the code, you can send me your interesting changes -by running: - svn diff - -and mailing me the result! :-P +Now, provided you used a clone of the repository, you can send me your changes. +See the file README, at the top of crosstool-NG source, for how to submit +changees. Preparing for packaging | ------------------------+ -- cgit v1.2.3