Add infrastructure support for John Polstra's new cvsup section. Update

various commentary which suggests which syncronization method to use.

4 files changed, 36 insertions, 52 deletions

diff --git a/share/doc/handbook/Makefile b/share/doc/handbook/Makefile
index bbb0bfe..76c78df 100644
--- a/share/doc/handbook/Makefile
+++ b/share/doc/handbook/Makefile
@@ -1,7 +1,7 @@
-# $Id: Makefile,v 1.18 1996/11/12 08:30:59 asami Exp $
+# $Id: Makefile,v 1.19 1996/11/28 18:09:24 jfieber Exp $
 
 SRCS= authors.sgml basics.sgml bibliography.sgml boothelp.sgml
-SRCS+= booting.sgml contrib.sgml crypt.sgml ctm.sgml current.sgml 
+SRCS+= booting.sgml contrib.sgml crypt.sgml ctm.sgml current.sgml cvsup.sgml
 SRCS+= cyclades.sgml development.sgml dialup.sgml dialout.sgml
 SRCS+= diskless.sgml dma.sgml eresources.sgml esdi.sgml 
 SRCS+= firewalls.sgml glossary.sgml goals.sgml
diff --git a/share/doc/handbook/sections.sgml b/share/doc/handbook/sections.sgml
index d9978be..ed2f3b5 100644
--- a/share/doc/handbook/sections.sgml
+++ b/share/doc/handbook/sections.sgml
@@ -1,4 +1,4 @@
-<!-- $Id: sections.sgml,v 1.17 1996/09/09 01:56:58 jkh Exp $ -->
+<!-- $Id: sections.sgml,v 1.18 1996/11/28 18:09:29 jfieber Exp $ -->
 <!-- The FreeBSD Documentation Project -->
 
 <!-- Entities containing all the pieces of the handbook are -->
@@ -9,6 +9,7 @@
 <!ENTITY booting SYSTEM "booting.sgml">
 <!ENTITY contrib SYSTEM "contrib.sgml">
 <!ENTITY ctm SYSTEM "ctm.sgml">
+<!ENTITY cvsup SYSTEM "cvsup.sgml">
 <!ENTITY current SYSTEM "current.sgml">
 <!ENTITY stable SYSTEM "stable.sgml">
 <!ENTITY crypt SYSTEM "crypt.sgml">
diff --git a/share/doc/handbook/sup.sgml b/share/doc/handbook/sup.sgml
index 7fbbb9b..77f348e 100644
--- a/share/doc/handbook/sup.sgml
+++ b/share/doc/handbook/sup.sgml
@@ -1,4 +1,4 @@
-<!-- $Id: sup.sgml,v 1.20 1996/11/07 12:32:05 asami Exp $ -->
+<!-- $Id: sup.sgml,v 1.21 1996/12/05 11:17:11 asami Exp $ -->
 <!-- The FreeBSD Documentation Project -->
 
 
@@ -9,27 +9,27 @@
 SUP is a network based software update tool developed at CMU.  The
 purpose of this document is get the beginner up and running with sup.
 
-<sect1><heading>Getting setup</heading>
+<sect1><heading>Configuration<label id="sup:setup"></heading>
 
 <p>SUP gets the information it needs to run from a configuration file 
 called a supfile.  There are different example supfiles provided
 for different source releases of FreeBSD.  The 
-<htmlurl url="file:/usr/share/examples/sup/standard-supfile"
+<url url="file:/usr/share/examples/sup/standard-supfile"
 name="/usr/share/examples/sup/standard-supfile"> file, for example,
 contains sup information for the latest standard FreeBSD source
 distributions - it tells sup what collections it will be updating
 and/or installing and where they go.  Someone using this particular
 supfile is said to be supping <ref id="current" name="-current">.
 <p>For ports, please have a look at 
-<htmlurl url="file:/usr/share/examples/sup/ports-supfile"
+<url url="file:/usr/share/examples/sup/ports-supfile"
 name="/usr/share/examples/sup/ports-supfile">.<p>
 If you are interested in obtaining the
-<htmlurl url="http://www.freebsd.org/cgi-bin/cvsweb" name="CVS"> files
+<url url="http://www.freebsd.org/cgi-bin/cvsweb" name="CVS"> files
 that make up the source tree, refer to
-<htmlurl url="file:/usr/share/examples/sup/cvs-supfile"
+<url url="file:/usr/share/examples/sup/cvs-supfile"
 name="/usr/share/examples/sup/cvs-supfile">.<p>
 If you would rather track changes to the -stable branch, refer to 
-<htmlurl url="file:/usr/share/examples/sup/stable-supfile"
+<url url="file:/usr/share/examples/sup/stable-supfile"
 name="/usr/share/examples/sup/stable-supfile"> instead.
 
 If you are inside the United States, you may also uncomment
@@ -37,14 +37,14 @@ the `secure' and `eBones' collection lines to grab the DES code.
 If you are outside the
 U.S., you should NOT sup this code from sup.FreeBSD.ORG as this will
 violate U.S. export restrictions.  Instead you should use the 
-<htmlurl url="file:/usr/share/examples/sup/secure-supfile"
+<url url="file:/usr/share/examples/sup/secure-supfile"
 name="secure-supfile"> in the sup examples directory.  This will
 connect you to the international sup site that contains a secure distribution.
 Any distributions you do not wish to receive can be commented out
 with a &num; at the beginning of the distribution line.
 
 Please consult the file
-<htmlurl url="file:/usr/share/examples/sup/README"
+<url url="file:/usr/share/examples/sup/README"
 name="/usr/share/examples/sup/README">
 for a list of alternate sup servers.  The default sup server (sup.FreeBSD.ORG)
 listed in the above example files is currently overloaded and any traffic 
@@ -69,7 +69,8 @@ a -current user.    If you are using the stable-supfile, please
 join the &a.stable and read
 <ref id="stable" name="Staying stable with FreeBSD">.
 
-<sect1><heading>Description of FreeBSD SUP distributions</heading>
+<sect1><heading>Distributions<label id="sup:dists">
+</heading>
 
 <p>For the main FreeBSD distribution using the standard-supfile:
 <verb>
diff --git a/share/doc/handbook/synching.sgml b/share/doc/handbook/synching.sgml
index dc145bc..150c63f 100644
--- a/share/doc/handbook/synching.sgml
+++ b/share/doc/handbook/synching.sgml
@@ -1,4 +1,4 @@
-<!-- $Id: synching.sgml,v 1.3 1996/10/04 22:54:16 wosch Exp $ -->
+<!-- $Id: synching.sgml,v 1.4 1996/12/16 22:38:07 mpp Exp $ -->
 <!-- The FreeBSD Documentation Project -->
 
 <chapt><heading>Synchronizing source trees over the Internet<label id="synching"></heading>
@@ -7,7 +7,7 @@
 
 <!--
 
-Last updated: $Date: 1996/10/04 22:54:16 $
+Last updated: $Date: 1996/12/16 22:38:07 $
 
 This document tries to describe the various ways in which a user may
 use the internet to keep development sources in synch.
@@ -16,53 +16,35 @@ use the internet to keep development sources in synch.
 <p>There are various ways of using an Internet (or email) connection
 to stay up-to-date with any given area of the FreeBSD project sources,
 or all areas, depending on what interests you.  The primary
-services we offer are CTM, SUP and CVSup (<bf>new</bf>).
+services we offer are CVSup and CTM.
 
-<p>It's been suggested by some that CTM obsoletes SUP.  This isn't quite
-true, in fact, because each tool was originally designed to serve a
-different constituency and, although they have both undergone significant
-improvement since first going into service, they take fundamentally
-different approaches in trying to solve the source synchronization problem.
-SUP was originally designed to support those who had dedicated (or at
-least fast) Internet connections whereas CTM was originally aimed at
-supporting those who's access was limited to email only.
-
-<p><bf>SUP</bf> (Software Update Protocol) is a system that tracks a local
-copy of the FreeBSD sources on your local disk and, using configuration files
-the user sets up, makes requests over the network to fetch and update any
-files which have changed on the FreeBSD master archive.
+<p><bf>CVSup</bf> is the new kid on the block, it does everything that sup
+did and more, doing it also far more effeciently in terms of its demands
+on server disk space and network resources.  Because of this, CVSup has
+largely replaced <ref id="sup"> in the FreeBSD Project.  Like sup, it also
+operates on a <em>pull</em> syncronization model.
 
 <p><bf>CTM</bf>, on the other hand, does not interactively compare
-the sources you have with those on the master archive.
-Instead, a script which identifies changes in files since its previous run
-is executed several times a day on the master archive, any detected changes
-being compressed, stamped with a sequence-number and encoded for transmission
-over email (printable ASCII only).  Once received, these "CTM deltas" can then
-be handed to the ctm_rmail(1) utility which will automatically decode, verify
+the sources you have with those on the master archive.  Instead, a script
+which identifies changes in files since its previous run is executed several
+times a day on the master archive, any detected changes being compressed,
+stamped with a sequence-number and encoded for transmission over email
+(printable ASCII only).  Once received, these "CTM deltas" can then be
+handed to the ctm_rmail(1) utility which will automatically decode, verify
 and apply the changes to the user's copy of the sources.  This process is
-far more efficient than SUP, and places less strain on our server resources
+far more efficient than CVSup, and places less strain on our server resources
 since it's a <em>push</em> rather than a <em>pull</em> model.
 
-<p>There are other trade-offs, of course.  With SUP, you can also
-inadvertently wipe out portions of your archive and SUP will detect
+<p>There are other trade-offs, of course.  With CVSup, you can also
+inadvertently wipe out portions of your archive and CVSup will detect
 and rebuild the damaged portions for you.  CTM won't do this, and if
 you wipe some portion of your source tree out (and don't have it backed
 up) then you will have to start from scratch (from the most recent CVS
 "base delta") and rebuild it all.
 
-<p>More recently, the waters have been muddied even more by
-the introduction of the <bf>CVSup</bf> utility, a highly efficient
-replacement for SUP which also offers access to any branch of FreeBSD
-development from a single CVS repository (which, in turn, can also be
-transferred non-destructively with CVSup - any local developer work on
-independent branches is preserved).  It overcomes many of SUP's shortcomings
-and may be <htmlurl url="ftp://freefall.freebsd.org/pub/CVSup/"
-name="downloaded"> from our development server, where additional documentation
-is also provided.  Both the CVSup client and server are compatible with
-the sup and supfilesrv distribution file formats.
-
-For more information on SUP and CTM, please see one of the following
-sections:
+For more information on CTM, CVSup or the now largely-obsolete sup, please
+see one of the following sections:
 
-   &sup;
    &ctm;
+   &cvsup;
+   &sup;