While cvsup is deprecated, as long as it is documented and working,

don't document bogus, ancient, or useless parts.

Approved by:	bcr (mentor)
This commit is contained in:
Eitan Adler 2013-02-18 19:54:21 +00:00
parent 17ce56d76b
commit 4df778e422
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=41010

View file

@ -1215,23 +1215,10 @@ src-all</programlisting>
In the default configuration, the
<application>CVSup</application> client will take every file
associated with the collection and tag you chose in the
configuration file. However, this is not always what you
want, especially if you are synching the
<filename>doc</filename>, <filename>ports</filename>, or
<filename>www</filename> trees &mdash; most people cannot
read four or five languages, and therefore they do not need
to download the language-specific files. If you are
<application>CVSup</application>ing the Ports Collection,
you can get around this by specifying each collection
individually (e.g., <emphasis>ports-astrology</emphasis>,
<emphasis>ports-biology</emphasis>, etc instead of simply
saying <emphasis>ports-all</emphasis>). However, since the
<filename>doc</filename> and <filename>www</filename> trees
do not have language-specific collections, you must use one
of <application>CVSup</application>'s many nifty features:
the <filename>refuse</filename> file.</para>
configuration file. In order to download a partial tree
use the <filename>refuse</filename> file.</para>
<para>The <filename>refuse</filename> file essentially tells
<para>The <filename>refuse</filename> file tells
<application>CVSup</application> that it should not take
every single file from a collection; in other words, it
tells the client to <emphasis>refuse</emphasis> certain
@ -1254,33 +1241,12 @@ src-all</programlisting>
translation of documentation, you can put the following in
your <filename>refuse</filename> file:</para>
<programlisting>doc/bn_*
doc/da_*
doc/de_*
doc/el_*
doc/es_*
doc/fr_*
doc/hu_*
doc/it_*
doc/ja_*
doc/mn_*
doc/nl_*
doc/no_*
doc/pl_*
doc/pt_*
doc/ru_*
doc/sr_*
doc/tr_*
doc/zh_*</programlisting>
<programlisting>bin/
usr.bin/</programlisting>
<para>and so forth for the other languages (you can find the
full list by browsing the
<ulink url="http://www.FreeBSD.org/cgi/cvsweb.cgi/">&os; CVS
repository</ulink>).</para>
<para>With this very useful feature, those users who are on
<para>With this very feature, those users who are on
slow links or pay by the minute for their Internet
connection will be able to save valuable time as they will
connection will be able to save time as they will
no longer need to download files that they will never use.
For more information on <filename>refuse</filename> files
and other neat features of <application>CVSup</application>,
@ -1372,11 +1338,8 @@ doc/zh_*</programlisting>
hierarchical relationships among collections are reflected by
the use of indentation in the list below.</para>
<para>The most commonly used collections are
<literal>src-all</literal>, and
<literal>ports-all</literal>. The other collections are used
only by small groups of people for specialized purposes, and
some mirror sites may not carry all of them.</para>
<para>The most commonly used collection is
<literal>src-all</literal>. </para>
<variablelist>
<varlistentry>
@ -1396,630 +1359,6 @@ doc/zh_*</programlisting>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-all release=cvs</literal></term>
<listitem>
<para>The &os; Ports Collection.</para>
<important id="cvsup-collec-pbase-warn">
<para>If you do not want to update the whole of
<literal>ports-all</literal> (the whole ports
tree), but use one of the subcollections listed
below, make sure that you
<emphasis>always</emphasis> update the
<literal>ports-base</literal> subcollection!
Whenever something changes in the ports build
infrastructure represented by
<literal>ports-base</literal>, it is virtually
certain that those changes will be used by
<quote>real</quote> ports real soon. Thus, if
you only update the <quote>real</quote> ports
and they use some of the new features, there is
a very high chance that their build will fail
with some mysterious error message. The
<emphasis>very first</emphasis> thing to do in
this case is to make sure that your
<literal>ports-base</literal> subcollection is
up to date.</para>
</important>
<important id="cvsup-collec-index-warn">
<para>If you are going to be building your own
local copy of <filename>ports/INDEX</filename>,
you <emphasis>must</emphasis> accept
<literal>ports-all</literal> (the whole ports
tree). Building
<filename>ports/INDEX</filename> with a partial
tree is not supported. See the <ulink
url="&url.books.faq;/applications.html#MAKE-INDEX">
FAQ</ulink>.</para>
</important>
<variablelist>
<varlistentry>
<term><literal>ports-accessibility
release=cvs</literal></term>
<listitem>
<para>Software to help disabled users.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-arabic
release=cvs</literal></term>
<listitem>
<para>Arabic language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-archivers
release=cvs</literal></term>
<listitem>
<para>Archiving tools.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-astro
release=cvs</literal></term>
<listitem>
<para>Astronomical ports.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-audio
release=cvs</literal></term>
<listitem>
<para>Sound support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-base
release=cvs</literal></term>
<listitem>
<para>The Ports Collection build
infrastructure - various files located in
the <filename>Mk/</filename> and
<filename>Tools/</filename> subdirectories
of <filename>/usr/ports</filename>.</para>
<note>
<para>Please see the <link
linkend="cvsup-collec-pbase-warn">important
warning above</link>: you should
<emphasis>always</emphasis> update this
subcollection, whenever you update any
part of the &os; Ports Collection!</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-benchmarks
release=cvs</literal></term>
<listitem>
<para>Benchmarks.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-biology
release=cvs</literal></term>
<listitem>
<para>Biology.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-cad
release=cvs</literal></term>
<listitem>
<para>Computer aided design tools.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-chinese
release=cvs</literal></term>
<listitem>
<para>Chinese language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-comms
release=cvs</literal></term>
<listitem>
<para>Communication software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-converters
release=cvs</literal></term>
<listitem>
<para>character code converters.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-databases
release=cvs</literal></term>
<listitem>
<para>Databases.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-deskutils
release=cvs</literal></term>
<listitem>
<para>Things that used to be on the desktop
before computers were invented.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-devel
release=cvs</literal></term>
<listitem>
<para>Development utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-dns
release=cvs</literal></term>
<listitem>
<para>DNS related software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-editors
release=cvs</literal></term>
<listitem>
<para>Editors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-emulators
release=cvs</literal></term>
<listitem>
<para>Emulators for other operating
systems.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-finance
release=cvs</literal></term>
<listitem>
<para>Monetary, financial and related
applications.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-ftp
release=cvs</literal></term>
<listitem>
<para>FTP client and server utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-games
release=cvs</literal></term>
<listitem>
<para>Games.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-german
release=cvs</literal></term>
<listitem>
<para>German language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-graphics
release=cvs</literal></term>
<listitem>
<para>Graphics utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-hebrew
release=cvs</literal></term>
<listitem>
<para>Hebrew language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-hungarian
release=cvs</literal></term>
<listitem>
<para>Hungarian language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-irc
release=cvs</literal></term>
<listitem>
<para>Internet Relay Chat utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-japanese
release=cvs</literal></term>
<listitem>
<para>Japanese language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-java
release=cvs</literal></term>
<listitem>
<para>&java; utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-korean
release=cvs</literal></term>
<listitem>
<para>Korean language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-lang
release=cvs</literal></term>
<listitem>
<para>Programming languages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-mail
release=cvs</literal></term>
<listitem>
<para>Mail software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-math
release=cvs</literal></term>
<listitem>
<para>Numerical computation software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-misc
release=cvs</literal></term>
<listitem>
<para>Miscellaneous utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-multimedia
release=cvs</literal></term>
<listitem>
<para>Multimedia software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-net
release=cvs</literal></term>
<listitem>
<para>Networking software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-net-im
release=cvs</literal></term>
<listitem>
<para>Instant messaging software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-net-mgmt
release=cvs</literal></term>
<listitem>
<para>Network management software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-net-p2p
release=cvs</literal></term>
<listitem>
<para>Peer to peer networking.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-news
release=cvs</literal></term>
<listitem>
<para>USENET news software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-palm
release=cvs</literal></term>
<listitem>
<para>Software support for
<trademark class="trade">Palm</trademark>
series.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-polish
release=cvs</literal></term>
<listitem>
<para>Polish language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-ports-mgmt
release=cvs</literal></term>
<listitem>
<para>Utilities to manage ports and
packages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-portuguese
release=cvs</literal></term>
<listitem>
<para>Portuguese language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-print
release=cvs</literal></term>
<listitem>
<para>Printing software.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-russian
release=cvs</literal></term>
<listitem>
<para>Russian language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-science
release=cvs</literal></term>
<listitem>
<para>Science.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-security
release=cvs</literal></term>
<listitem>
<para>Security utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-shells
release=cvs</literal></term>
<listitem>
<para>Command line shells.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-sysutils
release=cvs</literal></term>
<listitem>
<para>System utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-textproc
release=cvs</literal></term>
<listitem>
<para>text processing utilities (does not
include desktop publishing).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-ukrainian
release=cvs</literal></term>
<listitem>
<para>Ukrainian language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-vietnamese
release=cvs</literal></term>
<listitem>
<para>Vietnamese language support.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-www
release=cvs</literal></term>
<listitem>
<para>Software related to the World Wide
Web.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11
release=cvs</literal></term>
<listitem>
<para>Ports to support the X window
system.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-clocks
release=cvs</literal></term>
<listitem>
<para>X11 clocks.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-drivers
release=cvs</literal></term>
<listitem>
<para>X11 drivers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-fm
release=cvs</literal></term>
<listitem>
<para>X11 file managers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-fonts
release=cvs</literal></term>
<listitem>
<para>X11 fonts and font utilities.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-toolkits
release=cvs</literal></term>
<listitem>
<para>X11 toolkits.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-servers
release=cvs</literal></term>
<listitem>
<para>X11 servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-themes
release=cvs</literal></term>
<listitem>
<para>X11 themes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ports-x11-wm
release=cvs</literal></term>
<listitem>
<para>X11 window managers.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>projects-all release=cvs</literal>
@ -2326,15 +1665,6 @@ doc/zh_*</programlisting>
<para>&os; mailing list archive.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>www release=current</literal></term>
<listitem>
<para>The pre-processed &os; WWW site files (not the
source files). Used by WWW mirror sites.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>