www/anoncvs.html - diff

Return to anoncvs.html CVS log

Up to [local] / www

Diff for /www/anoncvs.html between version 1.225 and 1.226

version 1.225, 2004/11/24 20:29:47

version 1.226, 2004/12/03 03:24:17

Line 11

</head>

Line 43

tree up to date with respect to changes made to current OpenBSD sources.

In addition to following the bleeding edge of development, it is

also possible to track the patches for errata of a release.

The major advantage of Anonymous CVS over other source code update

Line 52

Line 51

commands available to control merging and updating your changes with

other source changes and for performing diffs, change histories

and other queries against the central repository.

The OpenBSD Project currently has five main source repositories:

<ul>

<li>src - Houses all source code for the OpenBSD Operating System.</li>

<li>src - Houses all source code for the OpenBSD Operating System.

<li>ports - Houses the <a href="./ports.html">OpenBSD Ports</a>.</li>

<li>ports - Houses the <a href="./ports.html">OpenBSD Ports</a>.

<li>www - Houses all OpenBSD web pages. (Including this one).</li>

<li>www - Houses all OpenBSD web pages. (Including this one).

<li>X11 - Houses OpenBSD's adaptation of the

<a href="http://www.XFree86.org/">XFree86-3</a> software project.</li>

<a href="http://www.XFree86.org/">XFree86-3</a> software project.

<li>XF4 - Houses OpenBSD's adaptation of the

This is here just for historical purposes, most users will have no

<a href="http://www.XFree86.org/">XFree86-4</a> software project.</li>

reason to use this tree, it is no longer being used.

<li>XF4 - Houses OpenBSD's active X source tree.

</ul>

Line 75

Line 73

"best efforts" to update your entire source tree, rather than

leaving you a list of arcane problems that have to be resolved before

continuing.

<a href="http://www.cvshome.org/">CVS</a> is the source code control

CVS is the source code control system used to manage the OpenBSD source tree.</a>

system used to <a href="why-cvs.html">manage the OpenBSD source

tree.</a>

It implements a central repository for all officially released source code

and changes, while permitting developers to maintain local copies of the

source code with their working changes. Developers with "write access"

source code with their working changes.

can commit changes directly to the OpenBSD source tree, while "Anonymous

CVS" users have "read access" and can keep their local copies of the

source up to date and issue queries against the central repository.

There are two levels of source tree access:

<ul>

<li>Read-write access for developers:

Developers who need to commit changes to the source tree must have an

account on the OpenBSD machines.

Getting this access will be a natural result of working on the sources

with other OpenBSD developers.

If someone does some good work and shows they can work with the team,

they will get an account.

<li>Read-only access for everyone:

Anyone can access the read-only CVS repositories.

These copies of the read-write CVS repository are mirrored often.

</ul>

The major strength of CVS is that it has the ability to perform intelligent

merges of changes to the central repository with changes that you make to

Line 97

Line 106

perform an update, your changes are not "blown away", rather CVS makes

best efforts to merge the changes made to the central sources with changes

you've made to your local copy.

In the event that the changes can't be completely merged, CVS provides a

"soft fallback", in terms of providing you with annotated changes to your

"soft fallback", providing you with annotated changes to your

local copy, preserving an unmodified copy of your version and continuing

to update any other source modules you requested.

<h3><a name="starting">Getting Started Using Anonymous

CVS</a></h3>

Line 122

Line 129

mounted on /mnt):

<pre>

# cd /usr/src; tar xzf /mnt/src.tar.gz

# cd /usr; tar xzf /mnt/XF4.tar.tz

# tar xzf /mnt/ports.tar.gz

</pre>

The source files for download from the FTP servers are separated into two

Line 137

Line 146

# cd /usr/src

# tar xzf ../sys.tar.gz

# tar xzf ../src.tar.gz

# cd /usr

# tar xzf XF4.tar.gz

# tar xzf ports.tar.gz

</pre>

Not all people will wish to unpack all the file sets, but as the system

must be kept in sync, you will generally need to set up all trees.

You can also just use cvs(1) to "checkout" the source repository

for you. This is discussed in the <a href="#using">next section</a>.

After this, /usr/src will be a nice checkout area where all

After this, <tt>/usr/src</tt> will be a nice checkout area where all

cvs(1)</a> commands will work properly.

Line 152

Line 168

source tree</a></h3>

CVS was designed to be a simple way to retrieve and update your sources,

CVS was designed to be a simple way to retrieve and update your sources.

therefore there isn't much involved at all in doing so. You must first

You must first decide whether you want to track -current or a

decide whether you want to track current or a patch branch.

<a href="stable.html">patch branch</a>.

The current tree has all of the up to the minute changes,

whereas a patch branch contains a formal release plus the patches

from the <a href="errata.html">errata</a> already applied. For a definition

from the <a href="errata.html">errata</a> and lesser issues already applied.

of current, see the <a href="faq/upgrade-minifaq.html#1.1">Upgrade

For more information on these "flavors" of OpenBSD, see

Mini-FAQ</a>.

<a href="faq/faq5.html#Flavors">here</a>.

Once you have decided which tree to follow, you must choose which Anonymous

CVS server you are going to use. A list of these servers is

<a href="#CVSROOT">below</a>. Do, however, notice that there are three ways

<a href="#CVSROOT">below</a>.

to access these servers.

<dl>

<dt>ssh<dd>Secure Shell can be used to access the anonymous CVS servers.

This is the recommended way of doing so, as it is encrypted. As of

2.6, OpenBSD has included OpenSSH in its standard distribution.

<dt>rsh<dd>Remote Shell can be used on some of the servers for users

who don't have access to <a href="http://www.openssh.com/">ssh</a>.

<dt>pserver<dd>pserver is primarily useful for users who are behind

firewalls that block the other two connections.

</dl>

NOTE: For users wishing to use rsh, you must first set the

<var>CVS_RSH</var> variable to rsh.

<ul>

<li>For Korn/Bourne shells:

<pre>

$ export CVS_RSH=/usr/bin/rsh

</pre>

<li>For csh/tcsh:

<pre>

% setenv CVS_RSH /usr/bin/rsh

</pre>

</ul>

Once you have chosen which <a href="#CVSROOT">Anonymous CVS Server</a> you will

use, and which method you will use, you can start using cvs. For those of you

use, you can start using cvs. For those of you

who have CDs you can start with the CVS checkout that is on the CD by using

the method <a href="#starting">above</a> to get the sources onto your system.

If you don't have a CD handy, use the method below to checkout the sources.

This method puts the OpenBSD source tree into /usr/src.

<pre>

# cd /usr; cvs checkout -P src

Line 209

Line 197

The above will checkout the current source tree. Many of you will

only want the patch branch sources. To checkout a patch branch, you must

specify a tag along with your command. Example:

<pre>

# cd /usr; cvs checkout -P -rOPENBSD_3_6 src

Line 224

Line 211

</a></h3>

There are two levels of source tree access:

<dl>

<dt>Read-write access for developers:

<dd>Developers who need to commit changes to the source tree must have

an account on the OpenBSD machines. Getting this access will be a

natural result of working on the sources with other OpenBSD developers.

If someone does some good work and shows they can work with the team,

they will get an account.

</dl>

<dl>

<dt>Read-only access for everyone:

<dd>Anyone can access the read-only CVS repositories. These copies

of the read-write CVS repository are mirrored often. To use one,

set your <var>CVSROOT</var> environment variable to one of

the following values:

Please see the note about <a href="#WHICH">ssh vs. rsh</a> below!

<ul>

Line 406

Line 375

Note: If your server is listed on here with inaccurate or

unknown information, please contact

<a href="mailto:beck@openbsd.org"><tt>beck@openbsd.org</tt></a>

You may want to use

Line 414

Line 382

to find out which server is nearest you.

Problems with a server should be reported to the maintainer of the

server in question.

</dl>

<h3><a name="CRYPTO">Getting crypto sources through

cvs(1)</a></h3>

Line 451

Line 418

</ul>

Because of the USA ITAR munitions list,

crypto software may only be exported to Canada from the USA.

<li>The OpenBSD project is looking for more anoncvs servers -- read

on to find out how you can help.

</ul>

<h3><a name="EXAMPLE">Example usages for cvs(1)

Line 515

Line 479

# cd /usr

# cvs -q get -rOPENBSD_3_6 -P src

</pre>

</li>

<li> Anytime afterwards, to `update' this tree:

(If you are following current):

Line 532

Line 495

Every time you ran this it would synchronize your /usr/src tree. It would

not destroy any of your local changes, rather it would attempt to merge

changes in. If you use obj directories (not obj symbolic links) you may

changes in.

wish to append "-I obj" to the cvs command line, this will keep cvs from

spitting out a warning about all the obj directories it is going to

encounter which are not in the repository.

<li> NOTE:

Line 546

Line 506

# cd /usr/src

# cvs -d $CVSROOT -q up -Pd

</pre>

</li>

</ul>

Line 575

Line 534

# cd /usr/ports

# cvs -q up -rOPENBSD_3_6 -Pd

</pre>

</li>

</ul>

In the above example, -q is optional, only intended to minimize

Line 596

Line 554

(included with the CVS sources) has much more

information about how CVS can be used.

<h4>X11 Source tree</h4>

Anoncvs mirrors also carry the OpenBSD X11 (XFree86) source tree. You can adapt

the recipe above to update your XFree86 source tree from the third CD.

You can copy or download the XFree86 3 source tree with the X11 cvs module,

although the current module containing XFree86 4 is XF4.

There are two ways to get the XF4 sources to /usr/XF4:

<ul>

<li>copy the tree off the CD (assuming the 3rd CD is mounted on /mnt):

<pre>

# cd /mnt; cp -Rp XF4 /usr

</pre>

<li>use a union mount with the CD below a writable directory.

<pre>

# mount -t union -o -b /mnt/XF4 /usr/XF4

</pre>

</ul>

After this, /usr/XF4 will be ready to be used by cvs. You can for

example update it to -current source (assuming you've already set

the <var>CVSROOT</var> environment variable):

<pre>

# cd /usr/XF4

# cvs -q update -Pd

</pre>

Warning:

When using cvs you should take care that your current directory is either

the root of the tree you are referencing or in a separate place such as /tmp.

Line 643

Line 572

CVS supports three access methods between the CVS server and the CVS

client:

<ul>

<li>ssh: Secure Shell can be used to access the anonymous CVS servers.

This is the recommended way of doing so, as it is encrypted.

<li>rsh: Remote Shell can be used on some of the servers for users

who don't have access to <a href="http://www.openssh.com/">ssh</a>.

<li>pserver: pserver is primarily useful for users who are behind

firewalls that block the other two connections.

</ul>

By default, the CVS client uses ssh ("secure shell":

NOTE: For users wishing to use rsh, you must first set the

<tt>CVS_RSH</tt> environment variable to point to the rsh(1) program:

<ul>

<li>For Korn/Bourne shells:

<pre>

$ export CVS_RSH=/usr/bin/rsh

</pre>

<li>For csh/tcsh:

<pre>

% setenv CVS_RSH /usr/bin/rsh

</pre>

</ul>

By default, OpenBSD's CVS client uses ssh ("secure shell":

<a href="http://www.openssh.com/">OpenSSH</a>) to talk to the CVS server.

Line 700

Line 658

which would mirror the cvs tree into /home/cvs with the sup data

files ending up in /home/sup. The full OpenBSD cvs tree is currently

about 2.2GB in size.

about 2.5GB in size, and will, of course continue to grow.

<h3><a name="MIRROR">Setting up an anoncvs mirror

</a></h3>