commits.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2009, Digium, Inc.
00005  *
00006  * See http://www.asterisk.org for more information about
00007  * the Asterisk project. Please do not directly contact
00008  * any of the maintainers of this project for assistance;
00009  * the project provides a web site, mailing lists and IRC
00010  * channels for your use.
00011  *
00012  * This program is free software, distributed under the terms of
00013  * the GNU General Public License Version 2. See the LICENSE file
00014  * at the top of the source tree.
00015  */
00016 
00017 /*!
00018  * \file
00019  */
00020 
00021 /*!
00022  * \page CommitMessages Guidelines for Commit Messages
00023  *
00024  * <hr>
00025  *
00026  * \section CommitMsgFormatting Commit Message Formatting
00027  *
00028  * The following illustrates the basic outline for commit messages:
00029  *
00030  * \verbatim
00031  * <One-liner summary of changes>
00032  *
00033  * <Empty Line> 
00034  *
00035  * <Verbose description of the changes>
00036  *
00037  * <Empty Line> 
00038  *
00039  * <Special Tags>
00040  * \endverbatim
00041  *
00042  * Some commit history viewers treat the first line of commit messages as the
00043  * summary for the commit.  So, an effort should be made to format our commit
00044  * messages in that fashion.  The verbose description may contain multiple 
00045  * paragraphs, itemized lists, etc. Always end the first sentence (and any
00046  * subsequent sentences) with punctuation.
00047  *
00048  * Commit messages should be wrapped at 80 %columns.
00049  *
00050  * \note For trivial commits, such as "fix the build", or "fix spelling mistake",
00051  *       the verbose description may not be necessary.
00052  *
00053  * <hr>
00054  *
00055  * \section CommitMsgTags Special Tags for Commit Messages
00056  *
00057  * \subsection MantisTags Mantis (https://issues.asterisk.org/)
00058  *
00059  * To have a commit noted in an issue, use a tag of the form: 
00060  * \arg (issue #1234)
00061  *
00062  * To have a commit automatically close an issue, use a tag of the form:
00063  * \arg (closes issue #1234)
00064  *
00065  * When making a commit for a mantis issue, it is easiest to use the
00066  * provided commit %message template functionality.  It will format the
00067  * special tags appropriately, and will also include information about who
00068  * reported the issue, which patches are being applied, and who did testing.
00069  * 
00070  * Assuming that you have bug marshal access (and if you have commit access,
00071  * it is pretty safe to assume that you do), you will find the commit %message
00072  * template section directly below the issue details section and above the
00073  * issue relationships section.  You will have to click the '+' next to
00074  * "Commit message template" to make the contents of the section visible.
00075  *
00076  * Here is an example of what the template will generate for you:
00077  *
00078  * \verbatim
00079  * (closes issue #1234)
00080  * Reported by: SomeGuy
00081  * Patches:
00082  *      fix_bug_1234.diff uploaded by SomeDeveloper (license 5678)
00083  * \endverbatim
00084  *
00085  * If the patch being committed was written by the person doing the commit,
00086  * and is not available to reference as an upload to the issue, there is no
00087  * need to include something like "fixed by me", as that will be the default
00088  * assumption when a specific patch is not referenced.
00089  *
00090  * \subsection ReviewBoardTags Review Board (https://reviewboard.asterisk.org/)
00091  *
00092  * To have a commit set a review request as submitted, include the full URL
00093  * to the review request.  For example:
00094  * \arg Review: %https://reviewboard.asterisk.org/r/95/
00095  *
00096  * \note The trailing slash in the review URL is required.
00097  *
00098  * <hr>
00099  *
00100  * \section CommitMsgSvnmerge Commit Messages with svnmerge
00101  *
00102  * When using the svnmerge tool for merging changes between branches, use the
00103  * commit %message generated by svnmerge.  The '-f' option to svnmerge allows
00104  * you to specify a file for svnmerge to write out a commit %message to.  The
00105  * '-F' option to svn commit allows you to specify a file that contains the
00106  * commit %message.
00107  *
00108  * If you are using the expect script wrappers for svnmerge from repotools,
00109  * a commit %message is automatically placed in the file '../merge.msg'.
00110  *
00111  * For more detailed information about working with branches and merging,
00112  * see the following page on %asterisk.org:
00113  * \arg https://wiki.asterisk.org/wiki/display/AST/Subversion+Usage
00114  */

Generated on Thu Apr 16 06:27:30 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6