os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add documentation for the -stable branch and reshuffle the sup/ctm chapters

Browse source 
since they're no longer appropriate under -current (you can use both for
synching with stable or CVS as well).
This commit is contained in:
Jordan K. Hubbard 1996-02-11 00:16:20 +00:00
parent 44946890d3
commit 827b1b2b29
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=253
7 changed files with 152 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
handbook/Makefile
View file

@ -1,4 +1,4 @@
# $Id: Makefile,v 1.7 1995-12-07 13:22:12 jkh Exp $
# $Id: Makefile,v 1.8 1996-02-11 00:16:06 jkh Exp $
SRCS= authors.sgml basics.sgml bibliography.sgml boothelp.sgml
SRCS+= booting.sgml contrib.sgml crypt.sgml ctm.sgml current.sgml dialup.sgml
@ -9,7 +9,7 @@ SRCS+= kernelconfig.sgml kerneldebug.sgml memoryuse.sgml
SRCS+= mirrors.sgml nfs.sgml nutshell.sgml
SRCS+= porting.sgml ports.sgml ppp.sgml printing.sgml relnotes.sgml
SRCS+= routing.sgml scsi.sgml sections.sgml
SRCS+= skey.sgml slipc.sgml slips.sgml submitters.sgml sup.sgml
SRCS+= troubleshooting.sgml userppp.sgml
SRCS+= skey.sgml slipc.sgml slips.sgml stable.sgml submitters.sgml sup.sgml
SRCS+= synching.sgml troubleshooting.sgml userppp.sgml
.include <bsd.sgml.mk>

16
handbook/current.sgml
View file

@ -1,4 +1,4 @@
<!-- $Id: current.sgml,v 1.8 1996-01-31 14:26:01 mpp Exp $ -->
<!-- $Id: current.sgml,v 1.9 1996-02-11 00:16:12 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
@ -10,7 +10,7 @@
THE FREEBSD CURRENT POLICY
Last updated: $Date: 1996-01-31 14:26:01 $
Last updated: $Date: 1996-02-11 00:16:12 $
This document attempts to explain the rationale behind
FreeBSD-current, what you should expect should you decide to run it,
@ -98,8 +98,9 @@ ask! It takes far too much time to do this as a general task.
entry for each change as it's made along with any pertinent
information on possible side-effects.
To join these lists, send mail to `majordomo@FreeBSD.ORG'
and say:
To join these lists, send mail to
<htmlurl url="mailto:majordomo@FreeBSD.ORG"
name="majordomo@FreeBSD.ORG"> and say:
<verb>
subscribe current
subscribe cvs-all
@ -125,10 +126,9 @@ ask! It takes far too much time to do this as a general task.
<item> Use ftp. The source tree for FreeBSD-current is always
"exported" on:
<verb>
ftp.FreeBSD.ORG:~ftp/pub/FreeBSD/FreeBSD-current
</verb>
We use `wu-ftpd' which allows compressed/tar'd grabbing
<htmlurl url="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-stable"
name="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-current">
We also use `wu-ftpd' which allows compressed/tar'd grabbing
of whole trees. e.g. you see:
<verb>
usr.bin/lex

6
handbook/handbook.sgml
View file

@ -1,4 +1,4 @@
<!-- $Id: handbook.sgml,v 1.39 1996-01-31 14:26:07 mpp Exp $ -->
<!-- $Id: handbook.sgml,v 1.40 1996-02-11 00:16:14 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
<!DOCTYPE linuxdoc PUBLIC "-//FreeBSD//DTD linuxdoc//EN" [
@ -132,8 +132,8 @@ Web server">.
<part><heading>Advanced topics</heading>
&current;
&ctm;
&sup;
&stable;
&synching;
&submitters;
&troubleshooting;
&kerneldebug;

4
handbook/sections.sgml
View file

@ -1,4 +1,4 @@
<!-- $Id: sections.sgml,v 1.7 1995-12-07 13:22:17 jkh Exp $ -->
<!-- $Id: sections.sgml,v 1.8 1996-02-11 00:16:15 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
<!-- Entities containing all the pieces of the handbook are -->
@ -10,6 +10,7 @@
<!ENTITY contrib SYSTEM "contrib.sgml">
<!ENTITY ctm SYSTEM "ctm.sgml">
<!ENTITY current SYSTEM "current.sgml">
<!ENTITY stable SYSTEM "stable.sgml">
<!ENTITY crypt SYSTEM "crypt.sgml">
<!ENTITY dialup SYSTEM "dialup.sgml">
<!ENTITY diskless SYSTEM "diskless.sgml">
@ -41,6 +42,7 @@
<!ENTITY slips SYSTEM "slips.sgml">
<!ENTITY submitters SYSTEM "submitters.sgml">
<!ENTITY sup SYSTEM "sup.sgml">
<!ENTITY synching SYSTEM "synching.sgml">
<!ENTITY troubleshooting SYSTEM "troubleshooting.sgml">
<!ENTITY userppp SYSTEM "userppp.sgml">

109
handbook/stable.sgml Normal file
View file

@ -0,0 +1,109 @@
<!-- $Id: stable.sgml,v 1.1 1996-02-11 00:16:17 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
<chapt><heading>Staying stable with FreeBSD<label id="stable"></heading>
<p><em>Contributed by &a.jkh;.</em>
<!--
THE FREEBSD STABLE POLICY
Last updated: $Date: 1996-02-11 00:16:17 $
This document attempts to explain the rationale behind
FreeBSD-stable, what you should expect should you decide to run it,
and states some prerequisites for making sure the process goes as
smoothly as possible.
-->
<sect><heading>What is FreeBSD-stable?</heading>
<p>FreeBSD-stable is our development branch for a more low-key and
conservative set of changes intended for our next mainstream release.
Changes of an experimental or untested nature do not go into this
branch (see <ref id="current" name="FreeBSD-current">).
<sect><heading>Who needs FreeBSD-stable?</heading>
<p>If you're a commercial user or someone who puts maximum stability of
their FreeBSD system before all other concerns, you should consider tracking
<em>stable</em>. This is especially true if you've installed the most
recent release (<htmlurl url="ftp://ftp.freebsd.org/pub/FreeBSD/2.1.0-RELEASE"
name="2.1.0-RELEASE"> at the time of this writing) since the <em>stable</em>
branch is effectively a bug-fix stream relative to the previous release.
<p>Please note that the <em>stable</em> tree endevors, above all, to
be fully compilable and stable at all times, but we do occasionally
make mistakes (these are still active sources with quickly-transmitted
updates, after all). We also do our best to thoroughly test fixes in
<em>current</em> before bringing them into <em>stable</em>, but sometimes
our tests fail to catch every case. If something breaks for you in
<em>stable</em>, please let us know <em>immediately!</em> (see
next section).
<sect><heading>Using FreeBSD-stable</heading>
<p><enum><item> Join the freebsd-stable mailing list. This will
keep you informed of build-dependencies that may appear in
<em>stable</em> or any other issues requring special attention.
Developers will also make announcements in this mailing list when
they are contemplating some contraversal fix or update, giving
the users a chance to respond if they have any issues to raise concerning
the proposed change.
To join this list, send mail to <htmlurl url="mailto:majordomo@FreeBSD.ORG"
name="majordomo@FreeBSD.ORG"> and say:
<verb>
subscribe freebsd-stable
</verb>
In the body of your message. Optionally, you can also say `help'
and Majordomo will send you full help on how to subscribe and
unsubscribe to the various other mailing lists we support.
<item> Grab the sources from ftp.FreeBSD.ORG. You can do this in
three ways:
<enum>
<item> Using the CTM facility described below. Unless you
have a good TCP/IP connection at a flat rate, this is
the way to do it.
<item> Use the CMU `sup' program (Software Update
Protocol), also described below.
This is the second most recommended method, since it allows
you to grab the entire collection once and then only what's
changed from then on. Many people run sup from cron
and keep their sources up-to-date automatically.
<item> Use ftp. The source tree for FreeBSD-stable is always
"exported" on:
<htmlurl url="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-stable"
name="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/FreeBSD-stable">
<p>We also use `wu-ftpd' which allows compressed/tar'd grabbing
of whole trees. e.g. you see:
<verb>
usr.bin/lex
</verb>
You can do:
<verb>
ftp> cd usr.bin
ftp> get lex.tar.Z
</verb>
And it will get the whole directory for you as a compressed
tar file.
</enum>
<item> Essentially, if you need rapid on-demand access to the source and
communications bandwidth is not a consideration, use sup or ftp.
Otherwise, use CTM.
<item> Before compiling stable, read the Makefile in /usr/src
carefully. You should at least run a `make world' the first time
through as part of the upgrading process.
Reading freebsd-stable will keep you up-to-date on other bootstrapping
procedures that sometimes become necessary as we move towards the next
release.
</enum>

9
handbook/sup.sgml
View file

@ -1,4 +1,4 @@
<!-- $Id: sup.sgml,v 1.12 1996-02-06 23:41:01 asami Exp $ -->
<!-- $Id: sup.sgml,v 1.13 1996-02-11 00:16:18 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
@ -57,11 +57,12 @@ like so:
Thats all there is to it! Remember that if you're running current,
which is what you will have if you sup with the standard-supfile, please
join the freebsd-current mailing list. You should also be sure to read
<ref id="current"
name="Staying current with FreeBSD">
<ref id="current" name="Staying current with FreeBSD">
for important information on just what we can and cannot do for you as
a -current user. If you are using the stable-supfile, please
join the freebsd-stable mailing list.
join the freebsd-stable mailing list and read
<ref id="stable" name="Staying stable with FreeBSD">
.
<sect1><heading>Description of FreeBSD SUP distributions</heading>

21
handbook/synching.sgml Normal file
View file

@ -0,0 +1,21 @@
<!-- $Id: synching.sgml,v 1.1 1996-02-11 00:16:20 jkh Exp $ -->
<!-- The FreeBSD Documentation Project -->
<chapt><heading>Synchronizing source trees over the Internet<label id="synching"></heading>
<p><em>Contributed by &a.jkh;.</em>
<!--
Last updated: $Date: 1996-02-11 00:16:20 $
This document tries to describe the various ways in which a user may
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 whatever collection of FreeBSD project sources
it is that interests you. The primary services we offer are:
&sup;
&ctm;