Author: bugman
Date: Fri Nov 29 09:18:55 2013
New Revision: 21700
URL: http://svn.gna.org/viewcvs/relax?rev=21700&view=rev
Log:
Added many small details to the release checklist document.
This is for the formatting and editing of the CHANGES file, which is used for
the release
announcements. Some additional details about the API documentation at
http://www.nmr-relax.com/api
have been added too.
Modified:
trunk/docs/Release_Checklist
Modified: trunk/docs/Release_Checklist
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/Release_Checklist?rev=21700&r1=21699&r2=21700&view=diff
==============================================================================
--- trunk/docs/Release_Checklist (original)
+++ trunk/docs/Release_Checklist Fri Nov 29 09:18:55 2013
@@ -25,7 +25,7 @@
$ svn log -v -r18314:HEAD > log
$ devel_scripts/log_converter.py log
-Commit the changes. Port the revision back into the main line.
+The result should be modified and every line checked. Bugs should be in the
'Bugfixes' section only if it affects previous relax releases, otherwise it
should be in the 'Changes' section. The following should be removed: minor,
insignificant, and unidentifiable changes such as "Import fix." (this is
highly subjective); all exclamation marks; message IDs for mailing list
posts; svnmerge commits; the messages of all reverted commits; all revision
numbers such as 'r19899' or the word 'revision'; the names and email
addresses of committers or patch providers; and all email addresses.
Spelling should be checked and proper punctuation used throughout, including
two spaces after a period. Missing spaces after punctuation due to the
log_converter.py script need to be corrected. Commit the changes. Port the
revision back into the main line.
@@ -118,7 +118,7 @@
$ scons api_manual_html
-Replace the old API documentation in the http://www.nmr-relax.com/api SVN
repository (http://svn.gna.org/viewcvs/relax/website) and commit the new
files.
+Replace the old API documentation in the http://www.nmr-relax.com/api SVN
repository (http://svn.gna.org/viewcvs/relax/website), update the
api/index.html file and commit the new files. If a new minor version is
being released, create a new directory such as api/3.1/, copy the files
there, and then edit the api/index.html file to add the new version.
r21700 - /trunk/docs/Release_Checklist