Difference between revisions of "Format commit logs"
Jump to navigation
Jump to search
(→Make a patch file: Transclusion of the {{historical svn}} template.) |
|||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __TOC__ | ||
| + | |||
== Format of commits == | == Format of commits == | ||
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 sufficient and not too trivial, I use this for the relax release announcement. | ||
| + | # A blank line. | ||
| + | # A description and link to the support request. | ||
| + | # Another blank line. | ||
| + | # All the details in multiple paragraphs if needed. | ||
| + | # The final blank line. | ||
== Make a patch file == | == Make a patch file == | ||
| + | {{historical svn}} | ||
In base directory of the relax software, do | In base directory of the relax software, do | ||
| − | svn diff > | + | svn diff > patch |
| + | Upload this file a the bug/tracker. | ||
| + | |||
| + | == relax_commit.txt == | ||
| + | This is a standard file for commit messages | ||
| + | <source lang="text"> | ||
| + | Fix for "PROBLEM" | ||
| + | |||
| + | Fix for bug #12345, (https://gna.org/bugs/?12345) - Title of bug | ||
| + | |||
| + | My name provided this patch, and was discovered during work on a XYZ machine. Commit by: name _aaattt_ domain_dot_com | ||
| + | |||
| + | This is a small fix for "PROBLEM" when issuing an external call to XYZ. | ||
| + | LONGER MESSAGE | ||
| + | |||
| + | </source> | ||
== Example 1 == | == Example 1 == | ||
| Line 27: | Line 52: | ||
</source> | </source> | ||
| − | [[Category: | + | |
| + | == See also == | ||
| + | [[Category:Development]] | ||
| + | [[Category:FAQ]] | ||
| + | [[Category:Git]] | ||
Latest revision as of 11:47, 27 October 2017
Format of commits
See http://www.nmr-relax.com/manual/Format_commit_logs.html
- 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.
- A blank line.
- A description and link to the support request.
- Another blank line.
- All the details in multiple paragraphs if needed.
- The final blank line.
Make a patch file
| Caution The information in this section is out of date but is kept for historical reasons. The relax source code is now hosted in a git rather than svn repository. |
In base directory of the relax software, do
svn diff > patch
Upload this file a the bug/tracker.
relax_commit.txt
This is a standard file for commit messages
Fix for "PROBLEM"
Fix for bug #12345, (https://gna.org/bugs/?12345) - Title of bug
My name provided this patch, and was discovered during work on a XYZ machine. Commit by: name _aaattt_ domain_dot_com
This is a small fix for "PROBLEM" when issuing an external call to XYZ.
LONGER MESSAGE
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.
