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