svn commit: r1346086 - /incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext

[ks...@apache.org]

Author: kschenk
Date: Mon Jun  4 18:56:28 2012
New Revision: 1346086

URL: http://svn.apache.org/viewvc?rev=1346086&view=rev
Log:
Added information about special commit tags

Modified:
    incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext

Modified: incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext
URL: http://svn.apache.org/viewvc/incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext?rev=1346086&r1=1346085&r2=1346086&view=diff
==============================================================================
--- incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext (original)
+++ incubator/ooo/site/trunk/content/openofficeorg/svn-basics.mdtext Mon Jun  4 18:56:28 2012
@@ -26,17 +26,19 @@ This page gives instructions on performi
 * [Repository Layout](#repository_layout)
 * [Getting the source code](#getting_the_source_code)
 * [Basic Work Cycle](#basic_work_cycle)
+* [Committing Changes](#committing_changes)
+* [Commit Message](#commit_message)
 * [Committing Changes By Others](#committing_changes_by_others)
 * [Creating and Submitting Patches](#creating_and_submitting_patches)
 * [Further Information](#further_information)
 
-## Overview
+## <a id="overview"></a>Overview
 
 You begin using Subversion by copying a directory from a remote repository to a local directory on your file system. This is known as a checkout of a working copy.
 
 Subversion uses a copy-modify-merge model meaning that you can add and edit files and directories in your working copy like any other files on your system, but you should use subversion commands for everything else such as `svn copy` and `svn move` instead of the operating system commands.
 
-## Sub-commands and Abbreviations
+## <a id="sub-commands_and_abbreviations"></a>Sub-commands and Abbreviations
 
 Subversion commands can be run from a command shell such as Bash on Linux. The subversion client command is `svn` followed by optional sub-commands, options, and arguments.
 
@@ -65,7 +67,7 @@ The following is only a partial list of 
 * `status` - Print the status of working copy files and directories
 * `update` - Bring changes from the repository into your working copy
 
-## Client Configuration
+## <a id="client_configuration"></a>Client Configuration
 
 Committers need to [configure their Subversion client][6] to handle the differences in line endings of text files on different operating systems.
 
@@ -73,7 +75,7 @@ There are instances where Subversion may
 
     $ export EDITOR=/usr/bin/vim
 
-## Repository Layout
+## <a id="repository_layout"></a>Repository Layout
 
 The OOo repository layout uses the following top-level directories `branches`, `site`, `tags`, and `trunk`.
 
@@ -99,7 +101,7 @@ From the parent directory of where you w
 
 "A" indicates file or directory is "Added" to working copy
 
-## Basic Work Cycle
+## <a id="basic_work_cycle"></a>Basic Work Cycle
 
 * Update your working copy - For this you use the `svn update` command
 *  Make changes - For this you may edit files in an editor, or use the `svn add`, `svn delete`, `svn copy`, `svn-move` commands
@@ -213,7 +215,7 @@ If you choose `e`, Subversion will launc
 
 "G" indicates "merGed"
 
-### Committing the Changes
+## <a id="committing_changes"></a>Committing Changes
 
 Only Committers can commit directly to the repository. The following example shows using your Apache ID and password.
 
@@ -225,19 +227,34 @@ Only Committers can commit directly to t
 
 For further information see the [Basic Work Cycle][8] page from [Subversion Book][2].
 
-## Committing Changes By Others
+## <a id="committing_changes"></a>Commit Message
+The examples in the previous sections use a simple commit message with the "-m" option.
 
-See the [Applying Patches][9] section of the Committer FAQ page.
+This is fine for some quick testing or for large bulk commits. However, we ask that
+your commits include special tagging to appropriately credit the patch.
+See the [crediting section](http://subversion.apache.org/docs/community-guide/conventions.html#crediting) of the Coding and Commit
+Conventions of the Apache Subversion project.
+
+Use of the special fields will enable processing by scripts like the
+[contribulyzer](http://www.red-bean.com/svnproject/contribulyzer/) to help quickly identify
+contributors.
+
+
+## <a id="committing_changes_by_others"></a>Committing Changes By Others
+
+See the [Applying Patches][9] section of the Committer FAQ page. Please use the special fields 
+described in the previous Commit Message section to commit changes supplied by others. 
 
 Example similar to one on Committer FAQ:
 
     Issue #43835:
     Added some cool new feature.
-    Submitted by: John Doe <john.doe.at.null.org>
+    Patch by: John Doe <john.doe.at.null.org>
+    Suggested by: Jane Brown <janeb.at.notnull.org>
 
-Using the `-m (--message)` option only allows a single line log message. To commit a multi-line message use the `-F (--file)` option (with a previously created file) or use neither -m or -F and an editor will be started.
+<!-- Using the `-m (--message)` option only allows a single line log message. To commit a multi-line message use the `-F (--file)` option (with a previously created file) or use neither -m or -F and an editor will be started. -->
 
-## Creating and Submitting Patches
+## <a id="creating_and_submitting_patches"></a>Creating and Submitting Patches
 
 See the [Sending in Patches][10] section on the Contributors Tech Guide page.
 
@@ -245,7 +262,7 @@ Create the patch file from `svn diff` wh
 
     svn diff > your-patch-name.patch
 
-## Further Information
+## <a id="further_information"></a>Further Information
 
 For more information see: