You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@openoffice.apache.org by Dave Fisher <da...@comcast.net> on 2011/07/24 04:51:41 UTC

Re: svn commit: r793236 - in /websites/production/openofficeorg: ./ content/openofficeorg/svn-basics.html

Hi Carl,

This is great!

I like the discussion about the svn commit, but as I've been thinking about the website version of this what I have been thinking about since I've never really done it is describing how to use patch to apply a patch created with "svn diff". I have been doing research on the topic and I see that there may be an "svn patch" in version 1.7, but I think we are at 1.6.

I would like to improve the page as follows:

(1) In the instructions about creating a patch:
(a) Ask the for the directory level in the repository where the patch should be applied.
One way to do this would be to save the output to svn info:

svn info > patch.info

(b) A list of files to be removed, if any. (I've read that patch does not handle this, but have not tested that information.)

(2) Instructions to the apply a patch step should include:
(a) Going to the correct directory level, possibly with patch.info.
(b) Removing files, if that is part of the patch.
(c) Running "svn status" to check for files that need to be added with "svn add"

(3) Additional pointers to svn information like
(a) http://tortoisesvn.net/
(b) http://subclipse.tigris.org/

What do you think?

I probably won't get to it for about 48 hours.

Regards,
Dave

On Jul 23, 2011, at 7:11 PM, cmarcum@apache.org wrote:

> Author: cmarcum
> Date: Sun Jul 24 02:11:44 2011
> New Revision: 793236
> 
> Log:
> publish changes to svn-basics
> 
> Modified:
>    websites/production/openofficeorg/   (props changed)
>    websites/production/openofficeorg/content/openofficeorg/svn-basics.html
> 
> Propchange: websites/production/openofficeorg/
> ------------------------------------------------------------------------------
> --- svn:mergeinfo (original)
> +++ svn:mergeinfo Sun Jul 24 02:11:44 2011
> @@ -1 +1 @@
> -/websites/staging/openofficeorg/trunk:791146-793041
> +/websites/staging/openofficeorg/trunk:791146-793235
> 
> Modified: websites/production/openofficeorg/content/openofficeorg/svn-basics.html
> ==============================================================================
> --- websites/production/openofficeorg/content/openofficeorg/svn-basics.html (original)
> +++ websites/production/openofficeorg/content/openofficeorg/svn-basics.html Sun Jul 24 02:11:44 2011
> @@ -74,17 +74,28 @@
>     <h1 class="title">Subversion Basics</h1>
>     <p>We use <a href="http://subversion.apache.org">Apache Subversion</a> for version control. For a complete reference on Subversion see the <a href="http://svnbook.red-bean.com">Subversion Book</a>. You can <a href="http://svn.apache.org/viewvc/incubator/ooo/trunk">browse our repository</a> in your web browser.</p>
> <p>This page gives instructions on performing basic development tasks using the Subversion Command-Line Client. This instruction assumes you have Apache Subversion installed.</p>
> +<ul>
> +<li><a href="#overview">Overview</a> </li>
> +<li><a href="#sub-commands_and_abbreviations">Sub-commands and Abbreviations</a> </li>
> +<li><a href="#client_configuration">Client Configuration</a></li>
> +<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_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>
> +</ul>
> <h2 id="overview">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>
> <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>to see the program version and modules</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>
> </pre></div>
> 
> 
> -<p>or a sub-command</p>
> +<p>Run a sub-command</p>
> <div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="sr">&lt;subcommand&gt;</span> <span class="p">[</span><span class="n">options</span><span class="p">]</span> <span class="p">[</span><span class="n">args</span><span class="p">]</span>
> </pre></div>
> 
> @@ -265,10 +276,30 @@ Select: (p) postpone, (df) diff-full, (e
> 
> 
> <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="submitting_changes_by_others">Submitting Changes By Others</h2>
> -<p>Coming Soon</p>
> +<h2 id="committing_changes_by_others">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.</p>
> +<p>Example similar to one on Committer FAQ:</p>
> +<div class="codehilite"><pre><span class="n">Issue</span> <span class="c1">#43835:</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 class="o">.</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;john.doe.at.null.org&gt;</span>
> +</pre></div>
> +
> +
> +<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>
> -<p>Coming Soon</p>
> +<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="further_information">Further Information</h2>
> +<p>For more information see: </p>
> +<ul>
> +<li><a href="http://subversion.apache.org">Apache Subversion Project</a></li>
> +<li><a href="http://svnbook.red-bean.com">Subversion Book</a></li>
> +<li><a href="http://www.apache.org/dev/">Apache Developer Information</a></li>
> +</ul>
>   </div>
> 
>   <div id="footer">
> 
> 


Re: svn commit: r793236 - in /websites/production/openofficeorg: ./ content/openofficeorg/svn-basics.html

Posted by Carl Marcum <ca...@codebuilders.net>.
Dave,

On 07/23/2011 10:51 PM, Dave Fisher wrote:
> Hi Carl,
>
> This is great!
>
> I like the discussion about the svn commit, but as I've been thinking about the website version of this what I have been thinking about since I've never really done it is describing how to use patch to apply a patch created with "svn diff". I have been doing research on the topic and I see that there may be an "svn patch" in version 1.7, but I think we are at 1.6.
>
> I would like to improve the page as follows:
>
> (1) In the instructions about creating a patch:
> (a) Ask the for the directory level in the repository where the patch should be applied.
> One way to do this would be to save the output to svn info:
>
> svn info>  patch.info
>
> (b) A list of files to be removed, if any. (I've read that patch does not handle this, but have not tested that information.)
>
> (2) Instructions to the apply a patch step should include:
> (a) Going to the correct directory level, possibly with patch.info.
> (b) Removing files, if that is part of the patch.
> (c) Running "svn status" to check for files that need to be added with "svn add"
>
> (3) Additional pointers to svn information like
> (a) http://tortoisesvn.net/
> (b) http://subclipse.tigris.org/
>
> What do you think?
>
> I probably won't get to it for about 48 hours.
>
> Regards,
> Dave
>

I think those are great improvements.

The svn-basics page currently isn't linked from the developer FAQ as 
requested in the help wanted. Would you like me to wait until you've 
made the change?

Best regards,
Carl