svn commit: r38842 -
head/en_US.ISO8859-1/books/fdp-primer/overview
Benjamin Kaduk
bjk at freebsd.org
Sun May 20 16:15:49 UTC 2012
On Sun, 20 May 2012, Glen Barber wrote:
> Author: gjb
> Date: Sun May 20 00:37:19 2012
> New Revision: 38842
> URL: http://svn.freebsd.org/changeset/doc/38842
>
> Log:
> Update the FDP Primer Overview chapter to reflect the CVS->SVN
> repository conversion:
Thanks for stepping up and doing this.
>
> - Update an overview of where (as in, what repository) various parts
> of the documentation project are located.
> - Update CVS->Subversion/svn where necessary.
> - Remove references to CVSup, CTM.
Interestingly, I noted while looking around to remind myself of a few
things, that we seem to not document svn as a way to keep src/ up-to-date,
in the handbook ("Synchronizing Your Source") -- just CVSup and CTM.
Perhaps a todo item?
> - Update commands for checking out the documentation tree.
> - In an example, prefer to use 'svn export foo bar' instead of
> 'cp -R foo bar', since the latter will also copy '.svn' directories
> (if they exist). 'svn export' is much cleaner, and will produce
> a diff that makes sense.
>
> Modified:
> head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
>
> Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
> ==============================================================================
> --- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml Sat May 19 23:49:28 2012 (r38841)
> +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml Sun May 20 00:37:19 2012 (r38842)
> @@ -133,15 +133,21 @@
> </varlistentry>
> </variablelist>
>
> - <para>These four groups of documentation are all available in the
> - FreeBSD CVS tree. This means that the logs of changes to these
> - files are visible to anyone, and anyone can use a program such
> - as <application>CVSup</application> or
> - <application>CTM</application> to keep local copies of this
> - documentation.</para>
> + <para>The documentation for the web site, &os; Handbook, and FAQ
> + are available in the <literal>doc/</literal> Subversion
> + repository, which is located at
> + <literal>svn://svn.FreeBSD.org/doc/</literal>.</para>
> +
> + <para>Manual pages are available in the <literal>src/</literal>
> + Subversion repository, which is available at
> + <literal>svn://svn.FreeBSD.org/base/</literal>.</para>
> +
> + <para>This means that the logs of changes to these
> + files are visible to anyone, and anyone can use
> + <application>svn</application> to view the changes.</para>
>
> <para>In addition, many people have written tutorials or other web
> - sites relating to FreeBSD. Some of these are stored in the CVS
> + sites relating to FreeBSD. Some of these are stored in the Subversion
> repository as well (where the author has agreed to this). In
> other cases the author has decided to keep his documentation
> separate from the main FreeBSD repository. The FDP endeavors to
> @@ -191,23 +193,23 @@
>
> <step>
> <para>Get a local copy of the FreeBSD <filename>doc</filename>
> - tree. Either use CVSup in <literal>checkout</literal> mode
> - to do this, or get a full copy of the CVS repository
> - locally.</para>
> -
> - <para>If you have the CVS repository locally then as a minimum
> - you will need to checkout the
> - <filename>doc/share</filename>, and
> - <filename>doc/en_US.ISO8859-1/share</filename>
> - directories.</para>
> + tree using <application>svn</application>.</para>
>
> - <screen>&prompt.user; <userinput>cvs checkout doc/share</userinput>
> -&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/share</userinput></screen>
> + <para>If network bandwidth or local drive space is a concern,
> + then at minimum, the <filename>head/share</filename> and
> + <filename>head/<replaceable>language</replaceable>/share</filename>
> + directories will need to be checked out. For
> + example:</para>
> +
> + <screen>&prompt.user; <userinput>mkdir -p head/share</userinput>
> +&prompt.user; <userinput>mkdir -p head/en_US.ISO8859-1/share</userinput>
> +&prompt.user; <userinput>svn checkout svn://svn.freebsd.org/doc/head/share head/share</userinput>
> +&prompt.user; <userinput>svn checkout svn://svn.freebsd.org/doc/head/en_US.ISO8859-1/share head/en_US.ISO8859-1/share</userinput></screen>
The repository URL appears as svn://svn.FreeBSD.org/doc/ above, but is all
lowercase here (and a couple other places). My personal preference would
be all lowercase, which makes it hard for me to remember exactly when (if
ever) the lowercase form of the domain/host name is actually supposed to
be used.
In any case, we should probably be consistent within the same document.
-Ben
>
> <para>If you have plenty of disk space then you could check
> out everything.</para>
>
> - <screen>&prompt.user; <userinput>cvs checkout doc</userinput></screen>
> + <screen>&prompt.user; <userinput>svn checkout svn://svn.freebsd.org/doc/head head</userinput></screen>
> </step>
>
> <step>
> @@ -225,7 +227,7 @@
> <para>Check out the <filename>articles</filename>
> directory.</para>
>
> - <screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/articles</userinput></screen>
> + <screen>&prompt.user; <userinput>svn checkout svn://svn.freebsd.org/doc/head/en_US.ISO8859-1/articles</userinput></screen>
> </step>
>
> <step>
> @@ -234,17 +236,17 @@
> belongs in a directory called
> <filename>vpn-w2k</filename>.</para>
>
> - <screen>&prompt.user; <userinput>cd doc/en_US.ISO8859-1/articles</userinput>
> -&prompt.user; <userinput>cp -R committers-guide vpn-w2k</userinput></screen>
> + <screen>&prompt.user; <userinput>cd head/en_US.ISO8859-1/articles</userinput>
> +&prompt.user; <userinput>svn export committers-guide vpn-w2k</userinput></screen>
> </step>
> </procedure>
>
> <para>If you wanted to edit an existing document, such as the
> FAQ, which is in
> - <filename>doc/en_US.ISO8859-1/books/faq</filename> you would
> + <filename>head/en_US.ISO8859-1/books/faq</filename> you would
> check it out of the repository like this.</para>
>
> - <screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/books/faq</userinput></screen>
> + <screen>&prompt.user; <userinput>svn checkout svn://svn.freebsd.org/doc/head/en_US.ISO8859-1/books/faq</userinput></screen>
> </step>
>
> <step>
More information about the svn-doc-head
mailing list