Re: svn commit: r1815234 - /subversion/site/staging/quick-start.html

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

Re: svn commit: r1815234 - /subversion/site/staging/quick-start.html

Johan Corveleyn-3
Hi Pavel,

Thanks for adding this.
I've spotted a couple of typo's, and some other small things. See below.

On Tue, Nov 14, 2017 at 6:09 PM,  <[hidden email]> wrote:
> Author: lyalyakin
> Date: Tue Nov 14 17:09:09 2017
> New Revision: 1815234
>
> URL: http://svn.apache.org/viewvc?rev=1815234&view=rev
> Log:
> Add to Quick Start a section about setting up a local repository and
> converting and existing project to a new working copy. The section on this

*an* existing project (you can propedit the commit message of r1815234 for that)

> topic was in the previous version of the Quick Start page.
>
> * staging/quick-start.html
>   (#setting-up-a-local-repo): New section.
>
> Modified:
>     subversion/site/staging/quick-start.html
>
> Modified: subversion/site/staging/quick-start.html
> URL: http://svn.apache.org/viewvc/subversion/site/staging/quick-start.html?rev=1815234&r1=1815233&r2=1815234&view=diff
> ==============================================================================
> --- subversion/site/staging/quick-start.html (original)
> +++ subversion/site/staging/quick-start.html Tue Nov 14 17:09:09 2017
> @@ -404,6 +404,80 @@ $ svn copy https://example.com/MyRepo/tr
>
>  </div>  <!-- #basic-tasks -->
>
> +<div class="h2" id="setting-up-a-local-repo">
> +<h2>Setting up a local repository
> +  <a class="sectionlink" href="#setting-up-a-local-repo"
> +    title="Link to this section">&para;</a>
> +</h2>

You should probably add this section to the TOC too.

Looking at that TOC currently (not related to this revision): it's a
bit strange right now. It references four "h2" sections, and one "h3"
section ("Branching and tagging"). It should probably either only
reference the h2 sections, or also include all the h3 sections (but
indented in the TOC, so it's clear which are h2 and which are h3
sections).

> +
> +<p>You can create a Subversion repository on your computer and use
> +<tt>file://</tt> schema to interact with it locally.  This approach can help

and use *the* file:// *scheme* (instead of schema).

> +you use Subversion locally to track personal files and single-person
> +projects.</p>
> +
> +<p>The following procedure creates a minimal environment for an an existing

double "an" above.

> +project.  It converts a directory with a project into a working copy of a
> +newly-created local Subversion repository.  As result you can modify the files
> +in the working copy and track the changes in your local repository.</p>
> +
> +<p>On Unix:</p>
> +  <ol>
> +    <li>Create a parent directory <tt>.svnrepos</tt> where you will place
> +        your SVN repositories:
> +        <pre>$ mkdir -p $HOME/.svnrepos/</pre></li>
> +    <li>Create a new repository MyRepo under <tt>.svnrepos</tt>:
> +        <pre>$ svnadmin create ~/.svnrepos/MyRepo</pre></li>
> +    <li>Create a recommended project layout in the new repository:
> +        <pre>$ svn mkdir -m "Create directory structure." \
> +  file://$HOME/.svnrepos/MyRepo/trunk \
> +  file://$HOME/.svnrepos/MyRepo/branches \
> +  file://$HOME/.svnrepos/MyRepo/tags</pre></li>
> +    <li>Change directory to <tt>./MyProject</tt> where your unvesioned

missing 'r' in unversioned.

> +        project is located:
> +        <pre>$ cd $HOME/MyProject</pre></li>
> +    <li>Convert the current directory into a working copy of the trunk/ in
> +        the repository:

I'd suggest adding another blurb of explanation here, to explain how
you're going to "convert" it. Something like: "Convert the current
directory into a working copy of the trunk/ of your repository, by
checking out the empty trunk and 'svn add'ing your files to it."

> +        <pre>$ svn checkout file://$HOME/.svnrepos/MyRepo/trunk ./</pre></li>
> +    <li>Schedule your project's files to be added to the repository:
> +        <pre>$ svn add --force ./</pre></li>

I'm wondering why you'd need '--force' here. Is that necessary? Maybe
newbees will wonder what it's for (or adopt this as a habit without
knowing what it does, which is even worse).

> +    <li>Commit the project's files:
> +        <pre>$ svn commit -m "Initial import."</pre></li>
> +    <li>Update your working copy:
> +        <pre>$ svn update</pre></li>
> +  </ol>
> +
> +<p>On Windows:</p>
> +  <ol>
> +    <li>Create a parent directory <tt>C:\Repositories</tt> where you will place
> +        your SVN repositories:
> +        <pre>mkdir C:\Repositories</pre></li>
> +    <li>Create a new repository MyRepo under <tt>C:\Repositories</tt>:
> +        <pre>svnadmin create C:\Repositories\MyRepo</pre></li>
> +    <li>Create a recommended project layout in the new repository:
> +        <pre>svn mkdir -m "Create directory structure." ^
> +  file:///C:/Repositories/MyRepo/trunk ^
> +  file:///C:/Repositories/MyRepo/branches ^
> +  file:///C:/Repositories/MyRepo/tags </pre></li>
> +    <li>Change directory to <tt>C:\MyProject</tt> where your unvesioned
> +        project is located:
> +        <pre>cd C:\MyProject</pre></li>
> +    <li>Convert the current directory into a working copy of the trunk/ in
> +        the repository:

Similar as above, add a small explanation what you mean by "convert".

> +        <pre>svn checkout file:///C:/Repositories/MyRepo/trunk .</pre></li>
> +    <li>Schedule your project's files to be added to the repository:
> +        <pre>svn add --force ./</pre></li>
> +    <li>Commit the project's files:
> +        <pre>svn commit -m "Initial import."</pre></li>
> +    <li>Update your working copy:
> +        <pre>svn update</pre></li>
> +  </ol>
> +
> +<p>See also the
> +<a href="http://svnbook.red-bean.com/nightly/en/svn.intro.quickstart.html"
> +>Quick Start instructions in The Subversion Book</a>.</p>
> +
> +</div>  <!-- #setting-up-a-local-repo -->
> +
>  <div class="h2" id="more-help">
>  <h2>Getting more help
>    <a class="sectionlink" href="#more-help"
>
>



--
Johan