Author: bugman
Date: Wed Sep 30 14:43:40 2015
New Revision: 27907
URL: http://svn.gna.org/viewcvs/relax?rev=27907&view=rev
Log:
Improvements for the release checklist document.
The backporting of the CHANGES file to trunk is now more obvious, and
instructions for fixing Epydoc
have been added.
Modified:
trunk/docs/devel/Release_Checklist
Modified: trunk/docs/devel/Release_Checklist
URL:
http://svn.gna.org/viewcvs/relax/trunk/docs/devel/Release_Checklist?rev=27907&r1=27906&r2=27907&view=diff
==============================================================================
--- trunk/docs/devel/Release_Checklist (original)
+++ trunk/docs/devel/Release_Checklist Wed Sep 30 14:43:40 2015
@@ -53,7 +53,9 @@
$ svn log -v -r18314:HEAD > log
$ ./devel_scripts/log_converter.py log > log_formatted
-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.
+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.
@@ -155,7 +157,7 @@
API documentation
-----------------
-Create the API documentation for the current version with the command:
+Firstly make sure that epydoc has been updated with the
docs/devel/epydoc_graphvis_fix.patch changes, to allow for newer Graphvis
versions to correctly create graphs. Then create the API documentation for the
current version with the command:
$ scons api_manual_html
_______________________________________________
relax (http://www.nmr-relax.com)
This is the relax-commits mailing list
[email protected]
To unsubscribe from this list, get a password
reminder, or change your subscription options,
visit the list information page at
https://mail.gna.org/listinfo/relax-commits
