From: markus schnalke Date: Mon, 2 Nov 2015 16:17:40 +0000 (+0100) Subject: Update README and release howto to new NEWS file X-Git-Tag: mmh-0.2~2 X-Git-Url: http://git.marmaro.de/?p=mmh;a=commitdiff_plain;h=c84cfab8f077f7e1929de69ba82587d999f769d9;hp=b11a6cdd6f0f7f6716744be10943c4676d6c1eb6 Update README and release howto to new NEWS file Also reorder the release steps to first check the tarball and then tag it as final. --- diff --git a/README b/README index fe62a4a..63037c2 100644 --- a/README +++ b/README @@ -44,6 +44,13 @@ do so, send a message to with the subject ``subscribe''. +Changes +------- +See the NEWS file for a summary of changes between releases. See +the ChangeLog file (which is included in releases as a static copy +of the VCS log) for a more detailed list of changes. + + Bug reports ----------- Please send bug reports and suggestions to the mailing list: @@ -71,6 +78,7 @@ There is more information in the docs subdirectory. Some of the documents are historic, however. The mmh website is located at . -Feel free to contact Markus Schnalke . +Feel free to write to mmh's mailing list at +or contact Markus Schnalke directly. (The nmh website is located at .) diff --git a/docs/README.releasing b/docs/README.releasing index c526fb3..fbc9877 100644 --- a/docs/README.releasing +++ b/docs/README.releasing @@ -11,20 +11,18 @@ here): 1. % echo 1.0 > VERSION % date +"%Y-%m-%d" > DATE - (DATE should contain something like "2012-12-08") + % vi NEWS - 2. % git commit VERSION DATE; git push + 2. % git commit VERSION DATE NEWS - 3. % git tag -a mmh-1.0 -m 'Releasing mmh-1.0' + 3. % make mmhdist - 4. % make mmhdist - - 5. Untar mmh-1.0.tar.gz and `diff -r' it vs. your workspace. Make + 4. Untar mmh-1.0.tar.gz and `diff -r' it vs. your workspace. Make sure no files got left out of the distribution that should be in it (due to someone forgetting to update the DIST variables in the Makefiles). - 6. If you have root access on your machine, it's good at this point + 5. If you have root access on your machine, it's good at this point to do: % chown -R 0:0 mmh-1.0 @@ -35,15 +33,19 @@ here): being installed, making it possible for that user to Trojan the mmh code before the system administrator finishes installing it. - 7. Make sure your new tarball uncompresses and untars with no problem. + 6. Make sure your new tarball uncompresses and untars with no problem. Make sure you can configure, make, and install mmh from it. - 8. If all is well and your tarball is final, go back to your workspace - and do: + 7. If all is well and your tarball is final, go back to your workspace + and tag the release: + + % git tag -a mmh-1.0 -m 'Releasing mmh-1.0' + + 8. Then bump the version number: % echo 1.0+dev > VERSION - 9. % git commit VERSION; git push + 9. % git commit VERSION 10. Generate an MD5 hash and a PGP signature of the tarball: