Date: Mon, 27 May 2002 11:33:41 +0200 (CEST) From: Marc Fonvieille <marc@blackend.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/38603: Tags addition and minor changes to cvsup-advanced article Message-ID: <200205270933.g4R9Xf1I054163@abigail.blackend.org>
next in thread | raw e-mail | index | archive | help
>Number: 38603
>Category: docs
>Synopsis: Tags addition and minor changes to cvsup-advanced article
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon May 27 02:40:01 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator: Marc Fonvieille
>Release: FreeBSD 4.6-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD abigail.blackend.org 4.6-PRERELEASE FreeBSD 4.6-PRERELEASE #5: Sun May 12 00:30:43 CEST 2002 marc@abigail.blackend.org:/usr/src/sys/compile/ABIGAIL i386
>Description:
Tags addition and minor changes to cvsup-advanced article:
- the software package CVSup should be tagged as an application
- the command cvsup should be tagged as a command
- quote tags should be used instead of ""
- a script should be tagged as a command
- supfile should be tagged as a filename
- all supfile's tag fields should be in literal
- no punctuation in a title
Read the patch below for more details.
>How-To-Repeat:
>Fix:
Apply the patch to articles/cvsup-advanced/article.sgml
--- article.sgml.diff begins here ---
--- article.sgml.orig Sun May 26 23:45:41 2002
+++ article.sgml Mon May 27 11:17:32 2002
@@ -25,9 +25,9 @@
<pubdate>$FreeBSD: doc/en_US.ISO8859-1/articles/cvsup-advanced/article.sgml,v 1.5 2002/05/26 21:45:41 keramida Exp $</pubdate>
<abstract>
- <para>The present article assumes a basic understanding of CVSup
+ <para>The present article assumes a basic understanding of <application>CVSup</application>
operation. It documents several delicate issues connected with
- source synchronization via CVSup, viz. effective solutions to
+ source synchronization via <application>CVSup</application>, viz. effective solutions to
the problem of stale files as well as special source updating
cases; which issues are likely to cause apparently inexplicable
troubles.</para>
@@ -38,7 +38,7 @@
<title>Preface</title>
<para>This document is the fruit of the author's attempts to
- fully understand the niceties of cvsup & source updating. :-)
+ fully understand the niceties of <command>cvsup</command> & source updating. :-)
While the author has made every effort to make these pages
as informative and correct as possible, he is only human and
may have made all sorts of typos, mistakes, etc. He will be
@@ -66,12 +66,12 @@
your base is <filename>/usr</filename>.</para>
<para>A checkouts file contains information on the current status
- of your sources -- in a way, a sort of "photograph". This
- significant information enables cvsup to retrieve updates most
- effectively. Further, and maybe more important, it enables cvsup
+ of your sources -- in a way, a sort of <quote>photograph</quote>. This
+ significant information enables <command>cvsup</command> to retrieve updates most
+ effectively. Further, and maybe more important, it enables <command>cvsup</command>
to correctly manage your sources by locally deleting any files
no longer present in the repository, thus leaving no stale files
- on your system. In fact, without a checkouts file, cvsup would
+ on your system. In fact, without a checkouts file, <command>cvsup</command> would
NOT know which files your collection was composed of (cf
&man.cvsup.1; and the fallback method for details); as a result,
it could NOT delete on your system those files no longer present
@@ -82,15 +82,15 @@
have got(ten) your installation CDs.</para>
<para>It is therefore recommended that you adopt the two-step procedure
- outlined in the Cvsup FAQ (cf Q12, Q13); in subsequent sections, you
+ outlined in the <application>CVSup</application> FAQ (cf Q12, Q13); in subsequent sections, you
will be given interesting and instructive concrete examples.</para>
</sect1>
<sect1 id="script">
- <title>A useful python script: cvsupchk</title>
+ <title>A useful python script: <command>cvsupchk</command></title>
<para>Alternatively, in order to examine your sources for
- inconsistencies, you may wish to utilize the cvsupchk python
+ inconsistencies, you may wish to utilize the <command>cvsupchk</command> python
script; which script is currently found in
<filename>/usr/ports/net/cvsup/work/cvsup-16.1/contrib/cvsupchk</filename>,
together with a nice <filename>README</filename>. Prerequisites:</para>
@@ -121,7 +121,7 @@
<screen>&prompt.user; <filename>/path/to/</filename><userinput>cvsupchk -d /usr -c /usr/sup/src-all/checkouts.cvs:RELENG_4 | more</userinput></screen>
- <para>In each case, cvsupchk will inspect your sources for
+ <para>In each case, <command>cvsupchk</command> will inspect your sources for
inconsistencies by utilizing the information contained in the
related checkouts file. Such anomalies as deleted files being
present (aka stale files), missing checked-out files, extra RCS
@@ -138,17 +138,17 @@
<sect2>
<title>How to safely change tags when updating
-<literal>src-all.</literal></title>
+<literal>src-all</literal></title>
- <para>If you specify eg tag=A in your supfile, cvsup will create
+ <para>If you specify eg <literal>tag=A</literal> in your <filename>supfile</filename>, <command>cvsup</command> will create
a checkouts file called <filename>checkouts.cvs:A</filename>:
- for instance, if tag=RELENG_4, a checkouts file called
+ for instance, if <literal>tag=RELENG_4</literal>, a checkouts file called
<filename>checkouts.cvs:RELENG_4</filename> is generated.
This file will be used to retrieve and/or store information
identifying your 4-STABLE sources.</para>
<para>When tracking <literal>src-all</literal>, if you wish to
- pass from tag=A to tag=B (A less/greater than B not making
+ pass from <literal>tag=A</literal> to <literal>tag=B</literal> (A less/greater than B not making
any difference) and if your checkouts file is
<filename>checkouts.cvs:A</filename>, the following actions
should be performed:</para>
@@ -162,17 +162,17 @@
</listitem>
<listitem>
- <para>write a supfile whose collection line reads:</para>
+ <para>write a <filename>supfile</filename> whose collection line reads:</para>
<programlisting>src-all tag=B</programlisting>
</listitem>
<listitem>
- <para>cvsup your sources using the new supfile.</para>
+ <para>cvsup your sources using the new <filename>supfile</filename>.</para>
</listitem>
</orderedlist>
- <para>Cvsup will look for <filename>checkouts.cvs:B</filename>
- -- in that the target is B; that is, cvsup will make use of
+ <para>The utility <command>cvsup</command> will look for <filename>checkouts.cvs:B</filename>
+ -- in that the target is B; that is, <command>cvsup</command> will make use of
the information contained therein to correctly manage your
sources.</para>
@@ -185,15 +185,15 @@
</listitem>
<listitem>
- <para>less load is placed on the server, in that cvsup
+ <para>less load is placed on the server, in that <command>cvsup</command>
operates in the most efficient way.</para>
</listitem>
</itemizedlist>
- <para>For example, A=RELENG_4, B=. The period in "B=." means
+ <para>For example, <literal>A=RELENG_4</literal>, <literal>B=.</literal>. The period in <literal>B=.</literal> means
-CURRENT. This is a rather typical update, from 4-STABLE
- to -CURRENT. While it is straightforward to "downgrade" your
+ to -CURRENT. While it is straightforward to <quote>downgrade</quote> your
sources (eg from -CURRENT to -STABLE), downgrading a system
is quite another matter. You are STRONGLY advised not to
attempt such an operation, unless you know exactly what you
@@ -203,24 +203,24 @@
<sect2>
<title>Updating to the same tag as of a different date</title>
- <para>If you wish to switch from "tag=A" to "tag=A" as of a
- different GMT date (say, "date=D"), you will execute the
+ <para>If you wish to switch from <literal>tag=A</literal> to <literal>tag=A</literal> as of a
+ different GMT date (say, <literal>date=D</literal>), you will execute the
following:</para>
<orderedlist>
<listitem>
- <para>write a supfile whose collection line reads:</para>
+ <para>write a <filename>supfile</filename> whose collection line reads:</para>
<programlisting>src-all tag=A date=D</programlisting>
</listitem>
<listitem>
- <para>update your sources using the new supfile</para>
+ <para>update your sources using the new <filename>supfile</filename></para>
</listitem>
</orderedlist>
<para>Whether the new date precedes that of the last sync
- operation with tag=A or not, it is immaterial. For example,
- in order to specify the date "August 27, 2000, 10:00:00 GMT"
+ operation with <literal>tag=A</literal> or not, it is immaterial. For example,
+ in order to specify the date <quote>August 27, 2000, 10:00:00 GMT</quote>
you write the line:</para>
@@ -237,19 +237,19 @@
is called <filename>checkouts.cvs:A</filename> (eg
<filename>checkouts.cvs:RELENG_4</filename>). As a result,
no particular action is needed in order to revert to the
- previous state: you have to modify the date in the supfile,
- and csvup again.</para>
+ previous state: you have to modify the date in the <filename>supfile</filename>,
+ and run <command>csvup</command> again.</para>
</sect2>
<sect2>
<title>Updating your ports collection for the first time</title>
- <para>Since ports are tagged "." (ie -CURRENT), you can
- correctly "sync" them for the first time by adding the date
+ <para>Since ports are tagged <quote>.</quote> (ie -CURRENT), you can
+ correctly <quote>sync</quote> them for the first time by adding the date
keyword (cf &man.cvsup.1; for the exact format): you should
- specify a date as close as possible to that of "shipping" of
- your ports tree. After cvsup has correctly created the ports
+ specify a date as close as possible to that of <quote>shipping</quote> of
+ your ports tree. After <command>cvsup</command> has correctly created the ports
checkouts file, which is precisely the goal of this first
special sync operation, the date field must be removed;
all subsequent updates will be carried out smoothly.</para>
--- article.sgml.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200205270933.g4R9Xf1I054163>