Difference between revisions of "Format commit logs"

From relax wiki
Jump to navigation Jump to search
Line 2: Line 2:
 
See http://www.nmr-relax.com/manual/Format_commit_logs.html
 
See http://www.nmr-relax.com/manual/Format_commit_logs.html
  
- The first line should be a quick summary under 100 characters.  If
+
# The first line should be a quick summary under 100 characters.  If
 
sufficient and not too trivial, I use this for the relax release
 
sufficient and not too trivial, I use this for the relax release
 
announcement.
 
announcement.
- A blank line.
+
# A blank line.
- A description and link to the support request.
+
# A description and link to the support request.
- Another blank line.
+
# Another blank line.
- All the details in multiple paragraphs if needed.
+
# All the details in multiple paragraphs if needed.
- The final blank line.
+
# The final blank line.
  
 
== Make a patch file ==
 
== Make a patch file ==

Revision as of 16:18, 21 June 2013

Format of commits

See http://www.nmr-relax.com/manual/Format_commit_logs.html

  1. The first line should be a quick summary under 100 characters. If

sufficient and not too trivial, I use this for the relax release announcement.

  1. A blank line.
  2. A description and link to the support request.
  3. Another blank line.
  4. All the details in multiple paragraphs if needed.
  5. The final blank line.

Make a patch file

In base directory of the relax software, do

svn diff > pathch

Upload this file a the bug/tracker. See

Example 1

Fix for bug #20915, (https://gna.org/bugs/?20915) - Failure of Grace opening
in MS Windows

My name provided this patch, and was discovered during work on a
Windows 7 system: name _aaattt_ domain_dot_com

This is a small fix for a wrong call to "raise
RelaxMissingBinaryError(binary)", when issuing an external call to xmgrace.

The "path_sep" would be equal = [/], and the RE search would not find(True)
the full path specified for the xmgrace file.
This is now shifted to python: os.path.isfile
http://docs.python.org/2/library/os.path.html

Another fix, is that as a standard the command "xmgrace" is provided. This
will work fine through windows cmd, but the true name for program in windows
is "xmgrace.exe", and so an additional search for +".exe" is also performed.