incubator-ooo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r820254 - in /websites/staging/openofficeorg/trunk/content: ./ openofficeorg/svn-basics.html
Date Mon, 04 Jun 2012 18:56:33 GMT
Author: buildbot
Date: Mon Jun  4 18:56:33 2012
New Revision: 820254

Staging update by buildbot for openofficeorg

    websites/staging/openofficeorg/trunk/content/   (props changed)

Propchange: websites/staging/openofficeorg/trunk/content/
--- cms:source-revision (original)
+++ cms:source-revision Mon Jun  4 18:56:33 2012
@@ -1 +1 @@

Modified: websites/staging/openofficeorg/trunk/content/openofficeorg/svn-basics.html
--- websites/staging/openofficeorg/trunk/content/openofficeorg/svn-basics.html (original)
+++ websites/staging/openofficeorg/trunk/content/openofficeorg/svn-basics.html Mon Jun  4
18:56:33 2012
@@ -104,14 +104,16 @@
 <li><a href="#repository_layout">Repository Layout</a></li>
 <li><a href="#getting_the_source_code">Getting the source code</a></li>
 <li><a href="#basic_work_cycle">Basic Work Cycle</a></li>
+<li><a href="#committing_changes">Committing Changes</a></li>
+<li><a href="#commit_message">Commit Message</a></li>
 <li><a href="#committing_changes_by_others">Committing Changes By Others</a></li>
 <li><a href="#creating_and_submitting_patches">Creating and Submitting Patches</a></li>
 <li><a href="#further_information">Further Information</a></li>
-<h2 id="overview">Overview</h2>
+<h2 id="wzxhzdk19wzxhzdk20overview"><a id="overview"></a>Overview</h2>
 <p>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.</p>
 <p>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 <code>svn copy</code> and <code>svn
move</code> instead of the operating system commands.</p>
-<h2 id="sub-commands-and-abbreviations">Sub-commands and Abbreviations</h2>
+<h2 id="wzxhzdk21wzxhzdk22sub-commands-and-abbreviations"><a id="sub-commands_and_abbreviations"></a>Sub-commands
and Abbreviations</h2>
 <p>Subversion commands can be run from a command shell such as Bash on Linux. The subversion
client command is <code>svn</code> followed by optional sub-commands, options,
and arguments.</p>
 <p>Show the program version and modules</p>
 <div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span>
<span class="o">--</span><span class="n">version</span>
@@ -139,14 +141,14 @@
 <li><code>status</code> - Print the status of working copy files and directories</li>
 <li><code>update</code> - Bring changes from the repository into your working
-<h2 id="client-configuration">Client Configuration</h2>
+<h2 id="wzxhzdk23wzxhzdk24client-configuration"><a id="client_configuration"></a>Client
 <p>Committers need to <a href="">configure
their Subversion client</a> to handle the differences in line endings of text files
on different operating systems.</p>
 <p>There are instances where Subversion may need to open an editor. You need to have
the environment variable EDITOR set to the editor you would like to use. To set it for the
current terminal session in Bash (your path may differ):</p>
 <div class="codehilite"><pre><span class="nv">$</span> <span class="nv">export</span>
<span class="n">EDITOR</span><span class="o">=</span><span class="sr">/usr/</span><span
class="n">bin</span><span class="o">/</span><span class="n">vim</span>
-<h2 id="repository-layout">Repository Layout</h2>
+<h2 id="wzxhzdk25wzxhzdk26repository-layout"><a id="repository_layout"></a>Repository
 <p>The OOo repository layout uses the following top-level directories <code>branches</code>,
<code>site</code>, <code>tags</code>, and <code>trunk</code>.</p>
 <li><code>branches</code> - Contains branches used for continued development
of a specific version, experimental versions, or for  developing features to be merged into
the trunk or a branch later. (needs examples)</li>
@@ -170,7 +172,7 @@ For more information see the <a href="ht
 <p>"A" indicates file or directory is "Added" to working copy</p>
-<h2 id="basic-work-cycle">Basic Work Cycle</h2>
+<h2 id="wzxhzdk27wzxhzdk28basic-work-cycle"><a id="basic_work_cycle"></a>Basic
Work Cycle</h2>
 <li>Update your working copy - For this you use the <code>svn update</code>
 <li>Make changes - For this you may edit files in an editor, or use the <code>svn
add</code>, <code>svn delete</code>, <code>svn copy</code>,
<code>svn-move</code> commands</li>
@@ -288,7 +290,7 @@ Select: (p) postpone, (df) diff-full, (e
 <p>"G" indicates "merGed"</p>
-<h3 id="committing-the-changes">Committing the Changes</h3>
+<h2 id="wzxhzdk29wzxhzdk30committing-changes"><a id="committing_changes"></a>Committing
 <p>Only Committers can commit directly to the repository. The following example shows
using your Apache ID and password.</p>
 <div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span>
<span class="n">commit</span> <span class="n">test</span><span
class="o">-</span><span class="n">file</span><span class="o">.</span><span
class="n">txt</span> <span class="o">--</span><span class="n">username</span>
<span class="n">your</span><span class="o">-</span><span class="n">name</span>
<span class="o">--</span><span class="n">password</span> <span
class="n">your</span><span class="o">-</span><span class="n">password</span>
<span class="o">\</span>
   <span class="o">-</span><span class="n">m</span> <span class="s">&quot;added
new line&quot;</span>
@@ -299,24 +301,36 @@ Select: (p) postpone, (df) diff-full, (e
 <p>For further information see the <a href="">Basic
Work Cycle</a> page from <a href="">Subversion Book</a>.</p>
-<h2 id="committing-changes-by-others">Committing Changes By Others</h2>
-<p>See the <a href="">Applying
Patches</a> section of the Committer FAQ page.</p>
+<h2 id="wzxhzdk31wzxhzdk32commit-message"><a id="committing_changes"></a>Commit
+<p>The examples in the previous sections use a simple commit message with the "-m"
+<p>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 <a href="">crediting
section</a> of the Coding and Commit
+Conventions of the Apache Subversion project.</p>
+<p>Use of the special fields will enable processing by scripts like the
+<a href="">contribulyzer</a>
to help quickly identify
+<h2 id="wzxhzdk33wzxhzdk34committing-changes-by-others"><a id="committing_changes_by_others"></a>Committing
Changes By Others</h2>
+<p>See the <a href="">Applying
Patches</a> section of the Committer FAQ page. Please use the special fields 
+described in the previous Commit Message section to commit changes supplied by others. </p>
 <p>Example similar to one on Committer FAQ:</p>
 <div class="codehilite"><pre><span class="n">Issue</span> <span
 <span class="n">Added</span> <span class="n">some</span> <span
class="n">cool</span> <span class="k">new</span> <span class="n">feature</span><span
-<span class="n">Submitted</span> <span class="n">by:</span> <span
class="n">John</span> <span class="n">Doe</span> <span class="sr">&lt;;</span>
+<span class="n">Patch</span> <span class="n">by:</span> <span
class="n">John</span> <span class="n">Doe</span> <span class="sr">&lt;;</span>
+<span class="n">Suggested</span> <span class="n">by:</span> <span
class="n">Jane</span> <span class="n">Brown</span> <span class="sr">&lt;;</span>
-<p>Using the <code>-m (--message)</code> option only allows a single line
log message. To commit a multi-line message use the <code>-F (--file)</code> option
(with a previously created file) or use neither -m or -F and an editor will be started.</p>
-<h2 id="creating-and-submitting-patches">Creating and Submitting Patches</h2>
+<!-- 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. -->
+<h2 id="wzxhzdk35wzxhzdk36creating-and-submitting-patches"><a id="creating_and_submitting_patches"></a>Creating
and Submitting Patches</h2>
 <p>See the <a href="">Sending
in Patches</a> section on the Contributors Tech Guide page.</p>
 <p>Create the patch file from <code>svn diff</code> where <code>your-patch-name.patch</code>
is the full path to the patch file to create.</p>
 <div class="codehilite"><pre><span class="n">svn</span> <span
class="n">diff</span> <span class="o">&gt;</span> <span class="n">your</span><span
class="o">-</span><span class="n">patch</span><span class="o">-</span><span
class="n">name</span><span class="o">.</span><span class="n">patch</span>
-<h2 id="further-information">Further Information</h2>
+<h2 id="wzxhzdk37wzxhzdk38further-information"><a id="further_information"></a>Further
 <p>For more information see: </p>
 <li><a href="">Apache Subversion Project</a></li>

View raw message