svn commit: r820608 - in /websites/staging/openofficeorg/trunk/content: ./ openofficeorg/svn-basics.html

[bu...@apache.org]

Author: buildbot
Date: Thu Jun  7 03:21:03 2012
New Revision: 820608

Log:
Staging update by buildbot for openofficeorg

Modified:
    websites/staging/openofficeorg/trunk/content/   (props changed)
    websites/staging/openofficeorg/trunk/content/openofficeorg/svn-basics.html

Propchange: websites/staging/openofficeorg/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jun  7 03:21:03 2012
@@ -1 +1 @@
-1347197
+1347349

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 Thu Jun  7 03:21:03 2012
@@ -110,10 +110,10 @@
 <li><a href="#creating_and_submitting_patches">Creating and Submitting Patches</a></li>
 <li><a href="#further_information">Further Information</a></li>
 </ul>
-<h2 id="wzxhzdk20wzxhzdk21overview"><a id="overview"></a>Overview</h2>
+<h2 id="wzxhzdk21wzxhzdk22overview"><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="wzxhzdk22wzxhzdk23sub-commands-and-abbreviations"><a id="sub-commands_and_abbreviations"></a>Sub-commands and Abbreviations</h2>
+<h2 id="wzxhzdk23wzxhzdk24sub-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>
@@ -141,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 copy</li>
 </ul>
-<h2 id="wzxhzdk24wzxhzdk25client-configuration"><a id="client_configuration"></a>Client Configuration</h2>
+<h2 id="wzxhzdk25wzxhzdk26client-configuration"><a id="client_configuration"></a>Client Configuration</h2>
 <p>Committers need to <a href="http://www.apache.org/dev/version-control.html#https-svn-config">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>
 </pre></div>
 
 
-<h2 id="wzxhzdk26wzxhzdk27repository-layout"><a id="repository_layout"></a>Repository Layout</h2>
+<h2 id="wzxhzdk27wzxhzdk28repository-layout"><a id="repository_layout"></a>Repository Layout</h2>
 <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>
 <ul>
 <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>
@@ -172,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="wzxhzdk28wzxhzdk29basic-work-cycle"><a id="basic_work_cycle"></a>Basic Work Cycle</h2>
+<h2 id="wzxhzdk29wzxhzdk30basic-work-cycle"><a id="basic_work_cycle"></a>Basic Work Cycle</h2>
 <ul>
 <li>Update your working copy - For this you use the <code>svn update</code> command</li>
 <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>
@@ -290,27 +290,42 @@ Select: (p) postpone, (df) diff-full, (e
 
 
 <p>"G" indicates "merGed"</p>
-<h2 id="wzxhzdk30wzxhzdk31committing-changes"><a id="committing_changes"></a>Committing Changes</h2>
+<h2 id="wzxhzdk31wzxhzdk32committing-changes"><a id="committing_changes"></a>Committing Changes</h2>
 <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>
+<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">c</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 C file&quot;</span>
 <span class="n">Sending</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="n">Transmitting</span> <span class="n">file</span> <span class="n">data</span> <span class="o">.</span>
 <span class="n">Committed</span> <span class="n">revision</span> <span class="mi">5</span><span class="o">.</span>
 </pre></div>
 
 
+<p>In general, you may not have to include always your username or password if you do a proper setup of your ssh key or have subversion store the password.</p>
+<p>Always check your changes with "svn diff" and "svn status". Also be careful to specify the files and/or directories you want to change, if
+you don't specify, SVN will commit <strong>all</strong> your changes.</p>
 <p>For further information see the <a href="http://svnbook.red-bean.com/nightly/en/svn.tour.cycle.html">Basic Work Cycle</a> page from <a href="http://svnbook.red-bean.com">Subversion Book</a>.</p>
-<h2 id="wzxhzdk32wzxhzdk33commit-message"><a id="commit_message"></a>Commit Message</h2>
+<h2 id="wzxhzdk33wzxhzdk34commit-message"><a id="commit_message"></a>Commit Message</h2>
 <p>The examples in the previous sections use a simple commit message with the "-m" option.</p>
-<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.
+<p>This is fine for some quick testing or for large bulk commits of code that you wrote.</p>
+<p>We ask that your commits include special tagging to appropriately credit the patch.
 See the <a href="http://subversion.apache.org/docs/community-guide/conventions.html#crediting">crediting section</a> of the Coding and Commit
 Conventions of the Apache Subversion project.</p>
+<p>Log comments are important.
+Information like author, where the change start/ends, the date, the bugzilla issue, and the author don't really belong
+in the code as SVN can keep it much more effectively without altering the coding style.
+Always try to use a log file for your commits. The previous commit when done by an experienced committer
+should actually look like this:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="n">ci</span> <span class="o">-</span><span class="n">F</span> <span class="n">test</span><span class="o">-</span><span class="nb">log</span><span class="o">.</span><span class="n">txt</span> <span class="n">test</span><span class="o">-</span><span class="n">file</span><span class="o">.</span><span class="n">c</span> 
+<span class="n">Sending</span>        <span class="n">test</span><span class="o">-</span><span class="n">file</span><span class="o">.</span><span class="n">c</span>
+<span class="n">Transmitting</span> <span class="n">file</span> <span class="n">data</span> <span class="o">.</span>
+<span class="n">Committed</span> <span class="n">revision</span> <span class="mi">5</span><span class="o">.</span>
+</pre></div>
+
+
 <p>Use of the special fields will enable processing by scripts like the
 <a href="http://www.red-bean.com/svnproject/contribulyzer/">contribulyzer</a> to help quickly identify
 contributors.</p>
-<h2 id="wzxhzdk34wzxhzdk35committing-changes-by-others"><a id="committing_changes_by_others"></a>Committing Changes By Others</h2>
+<h2 id="wzxhzdk35wzxhzdk36committing-changes-by-others"><a id="committing_changes_by_others"></a>Committing Changes By Others</h2>
 <p>See the <a href="http://www.apache.org/dev/committers.html#applying-patches">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>
@@ -330,14 +345,14 @@ described in the previous Commit Message
 </pre></div>
 
 
-<h2 id="wzxhzdk36wzxhzdk37creating-and-submitting-patches"><a id="creating_and_submitting_patches"></a>Creating and Submitting Patches</h2>
+<h2 id="wzxhzdk37wzxhzdk38creating-and-submitting-patches"><a id="creating_and_submitting_patches"></a>Creating and Submitting Patches</h2>
 <p>See the <a href="http://www.apache.org/dev/contributors.html#patches">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>
 </pre></div>
 
 
-<h2 id="wzxhzdk38wzxhzdk39further-information"><a id="further_information"></a>Further Information</h2>
+<h2 id="wzxhzdk39wzxhzdk40further-information"><a id="further_information"></a>Further Information</h2>
 <p>For more information see: </p>
 <ul>
 <li><a href="http://subversion.apache.org">Apache Subversion Project</a></li>