[svn-commits] russell: branch russell/project_docs r165436 - /team/russell/project_docs/inc...

[SVN commits to the Digium repositories]

Author: russell
Date: Thu Dec 18 07:49:28 2008
New Revision: 165436

URL: http://svn.digium.com/view/asterisk?view=rev&rev=165436
Log:
Update the commit message guidelines per mmichelson's review.  Thanks!

Modified:
    team/russell/project_docs/include/asterisk/doxyref.h

Modified: team/russell/project_docs/include/asterisk/doxyref.h
URL: http://svn.digium.com/view/asterisk/team/russell/project_docs/include/asterisk/doxyref.h?view=diff&rev=165436&r1=165435&r2=165436
==============================================================================
--- team/russell/project_docs/include/asterisk/doxyref.h (original)
+++ team/russell/project_docs/include/asterisk/doxyref.h Thu Dec 18 07:49:28 2008
@@ -363,6 +363,9 @@
  *
  * Commit messages should be wrapped at 80 %columns.
  *
+ * \note For trivial commits, such as "fix the build", or "fix spelling mistake",
+ *       the verbose description may not be necessary.
+ *
  * <hr/>
  *
  * \section CommitMsgTags Special Tags for Commit Messages
@@ -372,20 +375,27 @@
  * To have a commit noted in an issue, use a tag of the form: 
  * \arg (issue #1234)
  *
- * To have a commit automatically close an issue, use a of of the form:
+ * To have a commit automatically close an issue, use a tag of the form:
  * \arg (closes issue #1234)
  *
  * When making a commit for a mantis issue, it is easiest to use the
  * provided commit %message template functionality.  It will format the
  * special tags appropriately, and will also include information about who
  * reported the issue, which patches are being applied, and who did testing.
- * For example:
+ * 
+ * Assuming that you have bug marshal access (and if you have commit access,
+ * it is pretty safe to assume that you do), you will find the commit %message
+ * template section directly below the issue details section and above the
+ * issue relationships section.  You will have to click the '+' next to
+ * "Commit message template" to make the contents of the section visible.
+ *
+ * Here is an example of what the template will generate for you:
  *
   \verbatim
   (closes issue #1234)
   Reported by: SomeGuy
   Patches:
-       patch_for_stuff.diff uploaded by SomeGuy (license 5678)
+       fix_bug_1234.diff uploaded by SomeDeveloper (license 5678)
   \endverbatim
  *
  * If the patch being committed was written by the person doing the commit,
@@ -397,7 +407,7 @@
  *
  * To have a commit set a review request as submitted, include the full URL
  * to the review request.  For example:
- * \arg Review: http://reviewboard.digium.com/r/95/
+ * \arg Review: %http://reviewboard.digium.com/r/95/
  *
  * <hr/>
  *
@@ -411,6 +421,10 @@
  *
  * If you are using the expect script wrappers for svnmerge from repotools,
  * a commit %message is automatically placed in the file '../merge.msg'.
+ *
+ * For more detailed information about working with branches and merging,
+ * see the following page on %asterisk.org:
+ * \arg http://www.asterisk.org/developers/svn-branching-merging
  */
 
 /*!