diff options
Diffstat (limited to 'en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml')
| -rw-r--r-- | en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml | 63 |
1 files changed, 29 insertions, 34 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml index bc725c1544..007a6cb061 100644 --- a/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml +++ b/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml @@ -27,8 +27,7 @@ $FreeBSD$ --> - -<chapter id="working-copy"> +<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="working-copy"> <title>The Working Copy</title> <para>The <emphasis>working copy</emphasis> is a copy of the &os; @@ -42,13 +41,12 @@ for temporary files and test versions of various output formats.</para> - <para><ulink - url="&url.books.handbook;/svn.html"><application>Subversion</application></ulink> + <para><link xlink:href="&url.books.handbook;/svn.html"><application>Subversion</application></link> is used to manage the &os; documentation files. It is installed - by <filename role="package">textproc/docproj</filename> as one of + by <package>textproc/docproj</package> as one of the required applications.</para> - <sect1 id="working-copy-doc-and-src"> + <sect1 xml:id="working-copy-doc-and-src"> <title>Documentation and Manual Pages</title> <para>&os; documentation is not just books and articles. Manual @@ -65,34 +63,33 @@ to the latest version, called <literal>head</literal>.</para> </sect1> - <sect1 id="working-copy-choosing-mirror"> + <sect1 xml:id="working-copy-choosing-mirror"> <title>Choosing a Mirror</title> <para>To increase speed and reduce download time, select a mirror - from the list of <ulink - url="&url.books.handbook;/svn-mirrors.html">Subversion - mirror sites</ulink> that is close to your location. + from the list of <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion + mirror sites</link> that is close to your location. Substitute the chosen mirror <acronym>URL</acronym> for the <replaceable>https://svn0.us-west.FreeBSD.org/</replaceable> used in these examples.</para> </sect1> - <sect1 id="working-copy-choosing-directory"> + <sect1 xml:id="working-copy-choosing-directory"> <title>Choosing a Directory</title> <para>&os; documentation is traditionally stored in - <filename class="directory">/usr/doc/</filename>, and system + <filename>/usr/doc/</filename>, and system source code with manual pages in - <filename class="directory">/usr/src/</filename>. These + <filename>/usr/src/</filename>. These directory trees are relocatable, and users may want to put the working copies in other locations to avoid interfering with existing information in the main directories. The examples - that follow use <filename class="directory">~/doc</filename> - and <filename class="directory">~/src</filename>, both + that follow use <filename>~/doc</filename> + and <filename>~/src</filename>, both subdirectories of the user's home directory.</para> </sect1> - <sect1 id="working-copy-checking-out"> + <sect1 xml:id="working-copy-checking-out"> <title>Checking Out a Copy</title> <para>A download of a working copy from the repository is called @@ -101,15 +98,15 @@ copy of the latest version (<literal>head</literal>) of the main documentation tree:</para> - <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org/doc/head</replaceable> <replaceable>~/doc</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc</userinput></screen> <para>A checkout of the source code to work on manual pages is very similar:</para> - <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org/base/head</replaceable> <replaceable>~/src</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/base/head ~/src</userinput></screen> </sect1> - <sect1 id="working-copy-updating"> + <sect1 xml:id="working-copy-updating"> <title>Updating a Working Copy</title> <para>The documents and files in the &os; repository change daily. @@ -121,7 +118,7 @@ <command>svn update</command> on the directory containing the local working copy:</para> - <screen>&prompt.user; <userinput>svn update <replaceable>~/doc</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>svn update ~/doc</userinput></screen> <para>Get in the protective habit of using <command>svn update</command> before editing document files. @@ -132,7 +129,7 @@ the newer version from the repository.</para> </sect1> - <sect1 id="working-copy-revert"> + <sect1 xml:id="working-copy-revert"> <title>Reverting Changes</title> <para>Sometimes it turns out that changes were @@ -145,7 +142,7 @@ <screen>&prompt.user; <userinput>svn revert chapter.xml</userinput></screen> </sect1> - <sect1 id="working-copy-making-diff"> + <sect1 xml:id="working-copy-making-diff"> <title>Making a Diff</title> <para>After edits to a file or group of files are completed, the @@ -155,16 +152,16 @@ by redirecting the output of <command>svn diff</command> into a file:</para> - <screen>&prompt.user; <userinput>cd <replaceable>~/doc</replaceable></userinput> -&prompt.user; <userinput>svn diff > <replaceable>doc-fix-spelling.diff</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>cd ~/doc</userinput> +&prompt.user; <userinput>svn diff > doc-fix-spelling.diff</userinput></screen> <para>Give the file a meaningful name that identifies the contents. The example above is for spelling fixes to the whole documentation tree.</para> <para>If the diff file is to be submitted with the web - <quote><ulink url="&url.base;/send-pr.html">Submit a &os; - problem report</ulink></quote> interface, add a + <quote><link xlink:href="&url.base;/send-pr.html">Submit a &os; + problem report</link></quote> interface, add a <filename>.txt</filename> extension to give the earnest and simple-minded web form a clue that the contents are plain text.</para> @@ -175,19 +172,17 @@ be submitted yet, provide a list of only the files that are to be included:</para> - <screen>&prompt.user; <userinput>cd <replaceable>~/doc</replaceable></userinput> -&prompt.user; <userinput>svn diff <replaceable>disks/chapter.xml printers/chapter.xml</replaceable> > <replaceable>disks-printers.diff</replaceable></userinput></screen> + <screen>&prompt.user; <userinput>cd ~/doc</userinput> +&prompt.user; <userinput>svn diff disks/chapter.xml printers/chapter.xml > disks-printers.diff</userinput></screen> </sect1> - <sect1 id="working-copy-subversion-references"> + <sect1 xml:id="working-copy-subversion-references"> <title><application>Subversion</application> References</title> <para>These examples show very basic usage of <application>Subversion</application>. More detail is available - in the <ulink - url="http://svnbook.red-bean.com/">Subversion Book</ulink> - and the <ulink - url="http://subversion.apache.org/docs/">Subversion - documentation</ulink>.</para> + in the <link xlink:href="http://svnbook.red-bean.com/">Subversion Book</link> + and the <link xlink:href="http://subversion.apache.org/docs/">Subversion + documentation</link>.</para> </sect1> </chapter> |