Annotation of www/anoncvs.html, Revision 1.28
1.1 deraadt 1: <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML Strict//EN">
2: <html>
3: <head>
1.2 deraadt 4: <title>OpenBSD AnonCVS</title>
1.1 deraadt 5: <link rev=made href=mailto:www@openbsd.org>
6: <meta name="resource-type" content="document">
7: <meta name="description" content="the main OpenBSD page">
8: <meta name="keywords" content="openbsd,main">
9: <meta name="distribution" content="global">
1.13 deraadt 10: <meta name="copyright" content="This document copyright 1996 by OpenBSD.">
1.1 deraadt 11: </head>
12:
1.14 downsj 13: <BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#23238E">
1.1 deraadt 14:
1.14 downsj 15: <img alt="[OpenBSD]" SRC="images/smalltitle.gif">
16:
1.15 grr 17: <h1>OpenBSD</h1>
18: <hr>
19: <h3>Anonymous CVS Access:</h3>
20: <p>
21: Anonymous CVS is a method of keeping your local copy of the OpenBSD source
22: tree up to date with respect to changes made to current OpenBSD sources.
23: </p>
1.14 downsj 24: <p>
1.15 grr 25: The major advantage of Anonymous CVS over other source code update
26: techniques is that it works directly against a central source code
27: repository or mirror. This means that you have the full set of CVS
28: commands available to control merging and updating your changes with
29: other source changes and for performing diff's, change histories
30: and other queries against the central repository.
31: </p>
32: <h3>CVS:</h3>
33: CVS is the source code control system used to manage the OpenBSD source tree.
1.16 deraadt 34: It implements a central repository for all officially released source code
1.15 grr 35: and changes, while permitting developers to maintain local copies of the
36: source code with their working changes. Developers with "write access"
37: can commit changes directly to the OpenBSD source tree, while "Anonymous
38: CVS" users have "read access" and can keep their local copies of the source
39: up to date and issue queries against the central depository.
40: </p>
41: <p>
1.22 niklas 42: The major strength of CVS is that it has the ability to perform intelligent
1.15 grr 43: merges of changes to the central repository with changes that you make to
44: your local copy. This means that if you make a change to a module and
45: perform an update, your changes are not "blown away", rather CVS makes
46: best efforts to merge the changes made to the central sources with changes
47: you've made to your local copy.
48: </p>
49: <p>
50: In the event that the changes can't be completely merged, CVS provides a
51: "soft fallback", in terms of providing you with annotated changes to your
52: local copy, preeserving an unmodified copy of your version and continuing
53: to update any other source modules you requested.
1.1 deraadt 54: </p>
1.22 niklas 55: <p>
1.23 mickey 56: People who own an OpenBSD CD may have seen the CVS/ dirs on it.
1.22 niklas 57: Actually there is a reason, the CD has a checkout of the OpenBSD src/ module
1.23 mickey 58: usable to continue updating from. Using this tree will results in a much
59: faster initial CVS update than a fresh checkout of the full OpenBSD
60: source tree. There are two ways of using the CD:
61: <ul>
62: <li>copy the tree off it, (assuming the CD is mounted on /mnt):
1.22 niklas 63: <pre>
1.23 mickey 64: <b>#</b> cd /mnt; cp -Rp CVS Makefile bin distrib etc games gnu \
65: <b>></b> include kerberosIV lib libexec lkm regress sbin share \
66: <b>></b> sys usr.bin usr.sbin /usr/src
1.22 niklas 67: </pre>
1.23 mickey 68: <li>use a union mount with the CD below a writable directory.
1.22 niklas 69: <pre>
1.23 mickey 70: <b>#</b> mount -t union -o -b /mnt /usr/src
1.22 niklas 71: </pre>
1.23 mickey 72: </ul>
1.22 niklas 73: After this, /usr/src will be a nice checkout area where all cvs(1) commands
74: will work OK.
75: </p>
1.15 grr 76: <h4>CVS COMMAND SUMMARY</h4>
1.27 todd 77: <dt> cvs [cvs args] [cvs command] [cvs command args]
78: <dd> below is a listing of commonly used cvs commands.
1.15 grr 79: <dl>
80: <DT>add
81: <dd>Add a new file or directory to the repository.
82: <dt>get
83: <dd>Make a working directory of source files for editing.
84: <dt>commit
85: <dd>Apply changes to the source repository (write access)
86: <dt>diff
87: <dd>Show differences between local files and the source repository.
88: <dt>history
89: <dd>Show reports on cvs commands against the source repository.
90: <dt>log
91: <dd>Display CVS log information.
92: <dt>rdiff
93: <dd>Prepare a collection of diffs reflecting changes between release.
94: <dt>status
95: <dd>Show current status of files in the repository and local copies.
96: <dt>update
97: <DD>Bring your working directory up to date with the repository.
98: </dl>
1.1 deraadt 99: <p>
1.17 deraadt 100: To summarize, the real strengh of using Anonymous CVS is that it is
1.15 grr 101: a "tolerant" source code control system - it <strong>respects</strong>
102: changes that you have made to your local sources and makes <strong>
103: "best efforts"</strong> to update your entire source tree, rather than
104: leaving you a list of arcane problems that have to be resolved before
105: continuing.
1.1 deraadt 106: </p>
107:
1.15 grr 108: <h3>Using Anonymous CVS:</h3>
1.1 deraadt 109: <p>
110: The latest version of CVS is available at
111: <a href=ftp://ftp.cyclic.com/pub/cvs/>Cyclic</a>.
112: Versions earlier than 1.6 are not recommended, and may not work.
113: If you already have OpenBSD installed, CVS is included.
114: </p>
115:
116: <p>
117: There are two levels of source tree access:
118: </p>
119:
120: <dl>
121: <dt><strong>Read-write access for developers:</strong>
122: <dd>Developers who need to commit changes to the source tree must have
123: an account on the OpenBSD machines. Getting this access will be a
124: natural result of working on the sources with other OpenBSD developers.
125: If someone does some good work and shows they can work with the team,
126: they will get an account.
127: </dl>
128:
129: <dl>
130: <dt><strong>Read-only access for everyone:</strong>
131: <dd>Anyone can access the read-only CVS repositories. These copies
132: of the read-write CVS repository are mirrored often. To use one,
133: set your <strong>CVSROOT</strong> environment variable to one of
134: the following values:
1.12 grr 135: <p>
136: <strong>Please see the note about using ssh vs. rsh below!</strong>
137: <p>
1.1 deraadt 138: <ul>
139: <p>
140: <li><strong>CVSROOT=anoncvs@anoncvs.usa.openbsd.org:/cvs</strong><br>
1.10 millert 141: Host also known as <strong>anoncvs.openbsd.org</strong>,
142: <strong>anoncvs@anoncvs1.usa.openbsd.org</strong>,
143: <strong>anoncvs@anoncvs4.usa.openbsd.org</strong> and
144: <strong>anoncvs2.isc.org</strong>.<br>
145: located in California, western USA.<br>
146: maintained by <a href=mailto:niklas@openbsd.org>Niklas Hallqvist</a>.<br>
147: protocols: ssh only.<br>
1.1 deraadt 148: updated every 4 hours.<br>
149: <p>
150: <li><strong>CVSROOT=anoncvs@anoncvs2.usa.openbsd.org:/cvs</strong><br>
1.5 johns 151: Host also known as <strong>hydra.heuris.com</strong>.<br>
1.4 deraadt 152: located in St. Louis, Missouri, mid-western USA.<br>
1.1 deraadt 153: maintained by <a href=mailto:johns@heuris.com>John Stone</a>.<br>
154: protocols: rsh, ssh, ssh port 2022.<br>
155: updated every 12 hours.<br>
156: <p>
157: <li><strong>CVSROOT=anoncvs@anoncvs3.usa.openbsd.org:/cvs</strong><br>
158: Host also known as <strong>freestuff.cs.colorado.edu</strong>.<br>
159: located at the University of Colorado, Boulder, western USA.<br>
160: maintained by <a href=mailto:Todd.Miller@cs.colorado.edu>Todd Miller</a>.<br>
161: protocols: ssh, ssh port 2022.<br>
162: updated every 6 hours.<br>
163: <p>
1.18 todd 164: <li>
165: <strong>CVSROOT=:pserver:anoncvs@anoncvs5.usa.openbsd.org:/cvs</strong><br>
166: Note <a href=#pserver>*pserver usage*</a><br>
167: Host also known as <strong>alpha.ctaz.com</strong>.<br>
1.19 todd 168: located in Arizona, western USA.<br>
1.18 todd 169: maintained by <a href=mailto:todd@openbsd.org>Todd Fries</a>.<br>
170: protocols: :pserver:.<br>
1.20 todd 171: updated every 3 hours midnight to noon; exception is Mon-Wed-Sat with a midnight update, 3am full update, then a noon update.<br>
1.18 todd 172: <p>
1.24 deraadt 173: <li><strong>CVSROOT=anoncvs@anoncvs1.ca.openbsd.org:/cvs</strong><br>
174: Host also known as <strong>anoncvs@panopticon.ucs.ualberta.ca</strong><br>
175: located in Edmonton, Alberta, Canada.<br>
176: maintained by <A HREF="mailto:beck@panopticon.ucs.ualberta.ca">Bob Beck</A><br>
1.26 beck 177: protocols: rsh, ssh, ssh port 2022<br>
1.25 deraadt 178: updated every 4 hours.<br>
1.24 deraadt 179: <p>
1.1 deraadt 180: <li><strong>CVSROOT=anoncvs@anoncvs.uk.openbsd.org:/cvs</strong><br>
181: Host also known as <strong>dumpty.wonderland.org</strong>.<br>
182: located in London, UK.<br>
183: maintained by <a href=mailto:peter@wonderland.org>Peter Galbavy</a>.<br>
184: protocols: rsh.<br>
185: updated every 12 hours.<br>
186: <p>
187: <li><strong>CVSROOT=anoncvs@anoncvs.tw.openbsd.org:/cvs</strong><br>
188: Host also known as <strong>hercules.secc.fju.edu.tw</strong>.<br>
189: located in Taipei, Taiwan.<br>
190: maintained by <a href=mailto:shawn@openbsd.org>Shawn Hsiao</a>.<br>
191: protocols: rsh, ssh, ssh port 2022.<br>
192: updated every 12 hours.<br>
193: <p>
194: <li><strong>CVSROOT=anoncvs@anoncvs.no.openbsd.org:/cvs</strong><br>
195: located in Norway.<br>
196: maintained by <a href=mailto:micheals@openbsd.org>Michael Shuldman</a>.<br>
197: protocols: rsh, ssh, ssh port 2022.<br>
198: updated every 4 hours.<br>
199: </ul>
200: <p>
201: You may want to use `traceroute' to find out which server is nearest you.
1.11 michaels 202: Problems with a server should be reported to the <b>maintainer</b> of the
203: server in question.
1.1 deraadt 204: </dl>
205: </p>
206: <p>
207: <strong>IMPORTANT NOTE:</strong>
208: There are a few issues relating to cryptographic software that everyone
209: should be aware of:
210: <ul>
211: <li>The OpenBSD sources are from Canada.
1.9 deraadt 212: As
213: <a href=http://insight.mcmaster.ca/org/efc/pages/doc/crypto-export.html>
214: researched by a Canadian individual</a>
215: and as
216: <a href=http://axion.physics.ubc.ca/ECL.html>
217: described in the Export Control list of Canada</a>
218: is legal to export crypto software from Canada to the world.
1.1 deraadt 219: <p>
220: <li>However, if you are outside the USA or Canada, you should not
221: fetch the cryptographic sections of the OpenBSD sources from an
222: anoncvs server located in the USA. The files in question are...
223: <ul>
224: <li>src/kerberosIV/*
225: <li>src/lib/libc/crypt/crypt.c
226: <li>src/lib/libc/crypt/morecrypt.c
227: </ul>
228: Because of the USA ITAR munitions list,
229: crypto software may only be exported to Canada from the USA.
230: <p>
231: <li>The OpenBSD project is looking for more anoncvs servers -- read
232: on to find out how you can help.
233: </ul>
234: </p>
235:
236: <p>
237: A sample use of an anoncvs CVS server would be:
1.27 todd 238: <ul>
1.1 deraadt 239: <pre>
240: % setenv CVSROOT anoncvs@anoncvs.usa.openbsd.org:/cvs
241: % cd /tmp
242: % cvs get src/sys/arch/sparc
1.12 grr 243: [copies the files from the repository to your machine]
1.1 deraadt 244: % cvs log src/sys/arch/sparc/sparc/locore.s
1.12 grr 245: [shows the commit log for the chosen file ]
1.1 deraadt 246: % cvs diff -bc -r1.1 -r1.5 src/sys/arch/sparc/sparc/locore.s
1.12 grr 247: [shows the changes between revisions 1.1 and rev 1.5]
1.1 deraadt 248: </pre>
1.27 todd 249: </ul>
1.1 deraadt 250: </p>
251:
252: <p>
1.18 todd 253: <a name=pserver>In order to use a cvs ``pserver'' (a direct tcp connection instead of using ssh or rsh) you must login once:</a>
254: <pre>
255: [ *NOTE* You must be using cvs version 1.8 or higher to do this ]
256: % setenv CVSROOT :pserver:anoncvs@anoncvs5.usa.openbsd.org:/cvs
257: % cvs login
258: (Logging in to anoncvs@anoncvs5.usa.openbsd.org)
259: CVS password: <type whatever you feel like, just type something!>
260: [this writes a line to ~/.cvspass (filename over-ridden by CVS_PASSFILE).]
261: [An example line from my ~/.cvspass after typing 'blah' for the above ]
262: [password is: ]
263: [:pserver:anoncvs@anoncvs5.usa.openbsd.org:/cvs Au'yc ]
264: [...after logging in ONCE every other use of the above CVSROOT will work ]
265: % cvs -z9 get ksrc-i386 ksrc-common
266: [allows you to retrieve ONLY that necessary to rebuild an i386 kernel ]
267: [ -z9 allows gzip -9 compression, GOOD medicine for slow links ]
268: </pre>
269: </p>
270:
271: <p>
1.1 deraadt 272: Here is how someone using anoncvs regularily would update his
273: source tree:
1.27 todd 274: <ul><li>First, startout by `get'-ing an initial tree:
275:
1.1 deraadt 276: <pre>
277: # setenv CVSROOT anoncvs@anoncvs.usa.openbsd.org:/cvs
278: # cd /usr
279: # cvs -q get -PA src
280: </pre>
1.27 todd 281: </li>
282: <li> Anytime afterwards, to `update' this tree:
1.1 deraadt 283: <pre>
1.12 grr 284: # cd /usr
285: # cvs -q up -PAd src
1.1 deraadt 286: </pre>
1.27 todd 287:
1.1 deraadt 288: Everytime you ran this it would syncronize your /usr/src tree. It would
289: not destroy any of your local changes, rather it would attempt to merge
290: changes in. If you use obj directories (not obj symbolic links) you may
291: wish to append "-I obj" to the cvs command line, this will keep cvs from
292: spitting out a warning about all the obj directories it is going to
293: encounter which are not in the repository.
1.27 todd 294: </li>
295: </ul>
296:
297: In the above example, '-q' is optional, only intended to minimize
298: cvs's output. For those who like to see screenfulls of output, it
299: can be omitted.
1.1 deraadt 300: </p>
301:
302: <p>
1.12 grr 303: or to make a diff of a locally patched module (here cd.c) to include with
304: a bug report:
305: <pre>
306: # cd /usr
307: # cvs diff -u src/sys/scsi/cd.c > /tmp/patch
308: </pre>
309: </p>
310:
311: <p>
1.1 deraadt 312: The CVS man page (included with the CVS sources) has much more
313: information about how CVS can be used.
314: </p>
315:
316: <p>
1.12 grr 317: <strong>Warning:</strong>
318: When using cvs you should take care that your current directory is either
319: the root of the tree you're referencing or in a separate place such as /tmp.
320: Some commands such as "get" can create an arbitrary sub-tree in the current
321: directory, and a subsequent update will recursively flesh out this sub-tree.
322: </p>
323:
324: <p>
1.1 deraadt 325: The anoncvs service gives fledgling developers a chance to learn CVS
326: operation and get thoroughly involved in the development process
327: before getting "commit" access -- as a result of showing useful
328: skills and high quality results they will naturally later be given
329: developer access. As well, people providing patches can create
330: their "diff"s relative to the CVS tree, which will ease integration.
331: </p>
332:
333: <p>
1.15 grr 334: <strong>Anoncvs: rsh vs. ssh</strong>
1.12 grr 335: <br>
336: By default, the CVS client uses rsh to talk to the CVS server. Many
337: of the CVS sites no longer supprt rsh for security reasons or a local
338: problem like a firewall or imperfect protocol emulator such as slirp
339: may prevent you from using rsh.
340: The alternative is a to use a "secure shell" connection using
341: <a href=http://www.cs.hut.fi/ssh>ssh</a>. This is a commerical product
342: offered by <a href=http://www.ssh.fi>SSH Communications Security Ltd</a>,
343: however they make a free unix version available that can be easily
344: installed under OpenBSD. You can download the unix version from
345: <a href=http://www.cs.hut.fi/ssh>http://www.cs.hut.fi/ssh</a> or one of
346: the mirrors listed there.
347: </p>
1.28 ! beck 348:
! 349: <p> In this case, one sets the environment variable
! 350: <strong>CVS_RSH</strong> to point to ssh (typically
! 351: <strong>/usr/local/bin/ssh</strong>). If your local site prevents you
! 352: from connecting out to port 22 (which ssh defaults to using) use port
! 353: 2022.
1.1 deraadt 354: </p>
355:
356: <p>
357: Do not be tempted to turn on compression since CVS already compresses.
358: Use something like the following in your <strong>$HOME/.ssh/config</strong>
1.10 millert 359: file. Note that not all anoncvs servers allow ssh connections on
1.21 millert 360: port 2022. Also note that most anoncvs servers no longer accept
361: the <strong>none</strong> cipher as it is disabled in recent
362: versions of ssh for security reasons.
1.1 deraadt 363: </p>
364: <pre>
365: Host anoncvs.usa.openbsd.org
366: Port 2022
367: </pre>
368:
369: <p>
370: CVS is a little noisy starting up; to quiet it a bit you may want to
371: do this:
372: <pre>
373: setenv CVS_CLIENT_PORT -1
374: </pre>
375: </p>
376:
377: <p>
1.8 deraadt 378: If you wish to change from one CVS server to another (say your normal one is
379: down, or for any other reason), the environment variable which will let you
380: do this is
381: <pre>
382: setenv CVS_IGNORE_REMOTE_ROOT
383: </pre>
384: </p>
385:
386: <p>
1.1 deraadt 387: If you wish to be a new anoncvs mirror site, please contact the anoncvs
388: <a href=mailto:deraadt@theos.com>maintainer</a>.
389: Anoncvs mirrors require about 300MB of disk, and use up to 4MB of swap
390: per anoncvs user (assuming the user does a large operation; while smaller
391: operations use fewer resources, anoncvs still makes much more of an
392: impact than ftp or sup). Such anoncvs machines should have excellent
393: network connectivity for the area they are expected to serve. A
394: <a href=anoncvs.shar>document</a>
395: which describes the setup of anoncvs servers is available.
396: </p>
397:
398: </dl>
399:
400: <hr>
1.3 deraadt 401: <a href=index.html><img src=back.gif border=0 alt=OpenBSD></a>
1.1 deraadt 402: <a href=mailto:www@openbsd.org>www@openbsd.org</a>
1.28 ! beck 403: <br><small>$OpenBSD: anoncvs.html,v 1.27 1997/10/01 19:27:28 todd Exp $</small>
1.1 deraadt 404:
405: </body>
406: </html>