Annotation of www/anoncvs.html, Revision 1.22
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>
! 56: For people which own an OpenBSD CD, you may have seen the CVS/ dirs on there.
! 57: Actually there is a reason, the CD has a checkout of the OpenBSD src/ module
! 58: usable to continue updating from. Using this tree will result in a much
! 59: shorter initial CVS update time than a fresh checkout of the full OpenBSD
! 60: source tree. There are two ways of using the CD, either copy the tree off it,
! 61: or use a union mount with the CD below a writable directory. The former can
! 62: be accomplished by this command (assuming the CD is mounted on /mnt):
! 63: <pre>
! 64: <b>#</b> cd /mnt; cp -Rp CVS Makefile bin distrib etc games gnu include \
! 65: <b>><bt> kerberosIV lib libexec lkm regress sbin share sys usr.bin usr.sbin /usr/src
! 66: </pre>
! 67: The latter method requires this setup instead:
! 68: <pre>
! 69: <b>#</b> mount -t union -o -b /mnt /usr/Src
! 70: </pre>
! 71: After this, /usr/src will be a nice checkout area where all cvs(1) commands
! 72: will work OK.
! 73: </p>
1.15 grr 74: <h4>CVS COMMAND SUMMARY</h4>
75: <dl>
76: <DT>add
77: <dd>Add a new file or directory to the repository.
78: <dt>get
79: <dd>Make a working directory of source files for editing.
80: <dt>commit
81: <dd>Apply changes to the source repository (write access)
82: <dt>diff
83: <dd>Show differences between local files and the source repository.
84: <dt>history
85: <dd>Show reports on cvs commands against the source repository.
86: <dt>log
87: <dd>Display CVS log information.
88: <dt>rdiff
89: <dd>Prepare a collection of diffs reflecting changes between release.
90: <dt>status
91: <dd>Show current status of files in the repository and local copies.
92: <dt>update
93: <DD>Bring your working directory up to date with the repository.
94: </dl>
1.1 deraadt 95: <p>
1.17 deraadt 96: To summarize, the real strengh of using Anonymous CVS is that it is
1.15 grr 97: a "tolerant" source code control system - it <strong>respects</strong>
98: changes that you have made to your local sources and makes <strong>
99: "best efforts"</strong> to update your entire source tree, rather than
100: leaving you a list of arcane problems that have to be resolved before
101: continuing.
1.1 deraadt 102: </p>
103:
1.15 grr 104: <h3>Using Anonymous CVS:</h3>
1.1 deraadt 105: <p>
106: The latest version of CVS is available at
107: <a href=ftp://ftp.cyclic.com/pub/cvs/>Cyclic</a>.
108: Versions earlier than 1.6 are not recommended, and may not work.
109: If you already have OpenBSD installed, CVS is included.
110: </p>
111:
112: <p>
113: There are two levels of source tree access:
114: </p>
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@anoncvs2.usa.openbsd.org:/cvs</strong><br>
1.5 johns 147: Host also known as <strong>hydra.heuris.com</strong>.<br>
1.4 deraadt 148: located in St. Louis, Missouri, mid-western USA.<br>
1.1 deraadt 149: maintained by <a href=mailto:johns@heuris.com>John Stone</a>.<br>
150: protocols: rsh, ssh, ssh port 2022.<br>
151: updated every 12 hours.<br>
152: <p>
153: <li><strong>CVSROOT=anoncvs@anoncvs3.usa.openbsd.org:/cvs</strong><br>
154: Host also known as <strong>freestuff.cs.colorado.edu</strong>.<br>
155: located at the University of Colorado, Boulder, western USA.<br>
156: maintained by <a href=mailto:Todd.Miller@cs.colorado.edu>Todd Miller</a>.<br>
157: protocols: ssh, ssh port 2022.<br>
158: updated every 6 hours.<br>
159: <p>
1.18 todd 160: <li>
161: <strong>CVSROOT=:pserver:anoncvs@anoncvs5.usa.openbsd.org:/cvs</strong><br>
162: Note <a href=#pserver>*pserver usage*</a><br>
163: Host also known as <strong>alpha.ctaz.com</strong>.<br>
1.19 todd 164: located in Arizona, western USA.<br>
1.18 todd 165: maintained by <a href=mailto:todd@openbsd.org>Todd Fries</a>.<br>
166: protocols: :pserver:.<br>
1.20 todd 167: 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 168: <p>
1.1 deraadt 169: <li><strong>CVSROOT=anoncvs@anoncvs.uk.openbsd.org:/cvs</strong><br>
170: Host also known as <strong>dumpty.wonderland.org</strong>.<br>
171: located in London, UK.<br>
172: maintained by <a href=mailto:peter@wonderland.org>Peter Galbavy</a>.<br>
173: protocols: rsh.<br>
174: updated every 12 hours.<br>
175: <p>
176: <li><strong>CVSROOT=anoncvs@anoncvs.tw.openbsd.org:/cvs</strong><br>
177: Host also known as <strong>hercules.secc.fju.edu.tw</strong>.<br>
178: located in Taipei, Taiwan.<br>
179: maintained by <a href=mailto:shawn@openbsd.org>Shawn Hsiao</a>.<br>
180: protocols: rsh, ssh, ssh port 2022.<br>
181: updated every 12 hours.<br>
182: <p>
183: <li><strong>CVSROOT=anoncvs@anoncvs.no.openbsd.org:/cvs</strong><br>
184: located in Norway.<br>
185: maintained by <a href=mailto:micheals@openbsd.org>Michael Shuldman</a>.<br>
186: protocols: rsh, ssh, ssh port 2022.<br>
187: updated every 4 hours.<br>
188: </ul>
189: <p>
190: You may want to use `traceroute' to find out which server is nearest you.
1.11 michaels 191: Problems with a server should be reported to the <b>maintainer</b> of the
192: server in question.
1.1 deraadt 193: </dl>
194: </p>
195: <p>
196: <strong>IMPORTANT NOTE:</strong>
197: There are a few issues relating to cryptographic software that everyone
198: should be aware of:
199: <ul>
200: <li>The OpenBSD sources are from Canada.
1.9 deraadt 201: As
202: <a href=http://insight.mcmaster.ca/org/efc/pages/doc/crypto-export.html>
203: researched by a Canadian individual</a>
204: and as
205: <a href=http://axion.physics.ubc.ca/ECL.html>
206: described in the Export Control list of Canada</a>
207: is legal to export crypto software from Canada to the world.
1.1 deraadt 208: <p>
209: <li>However, if you are outside the USA or Canada, you should not
210: fetch the cryptographic sections of the OpenBSD sources from an
211: anoncvs server located in the USA. The files in question are...
212: <ul>
213: <li>src/kerberosIV/*
214: <li>src/lib/libc/crypt/crypt.c
215: <li>src/lib/libc/crypt/morecrypt.c
216: </ul>
217: Because of the USA ITAR munitions list,
218: crypto software may only be exported to Canada from the USA.
219: <p>
220: <li>The OpenBSD project is looking for more anoncvs servers -- read
221: on to find out how you can help.
222: </ul>
223: </p>
224:
225: <p>
226: A sample use of an anoncvs CVS server would be:
227: <pre>
228: % setenv CVSROOT anoncvs@anoncvs.usa.openbsd.org:/cvs
229: % cd /tmp
230: % cvs get src/sys/arch/sparc
1.12 grr 231: [copies the files from the repository to your machine]
1.1 deraadt 232: % cvs log src/sys/arch/sparc/sparc/locore.s
1.12 grr 233: [shows the commit log for the chosen file ]
1.1 deraadt 234: % cvs diff -bc -r1.1 -r1.5 src/sys/arch/sparc/sparc/locore.s
1.12 grr 235: [shows the changes between revisions 1.1 and rev 1.5]
1.1 deraadt 236: </pre>
237: </p>
238:
239: <p>
1.18 todd 240: <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>
241: <pre>
242: [ *NOTE* You must be using cvs version 1.8 or higher to do this ]
243: % setenv CVSROOT :pserver:anoncvs@anoncvs5.usa.openbsd.org:/cvs
244: % cvs login
245: (Logging in to anoncvs@anoncvs5.usa.openbsd.org)
246: CVS password: <type whatever you feel like, just type something!>
247: [this writes a line to ~/.cvspass (filename over-ridden by CVS_PASSFILE).]
248: [An example line from my ~/.cvspass after typing 'blah' for the above ]
249: [password is: ]
250: [:pserver:anoncvs@anoncvs5.usa.openbsd.org:/cvs Au'yc ]
251: [...after logging in ONCE every other use of the above CVSROOT will work ]
252: % cvs -z9 get ksrc-i386 ksrc-common
253: [allows you to retrieve ONLY that necessary to rebuild an i386 kernel ]
254: [ -z9 allows gzip -9 compression, GOOD medicine for slow links ]
255: </pre>
256: </p>
257:
258: <p>
1.1 deraadt 259: Here is how someone using anoncvs regularily would update his
260: source tree:
261: <pre>
262: # setenv CVSROOT anoncvs@anoncvs.usa.openbsd.org:/cvs
263: # cd /usr
264: # cvs -q get -PA src
265: </pre>
1.12 grr 266: or similarily later on he might try:
1.1 deraadt 267: <pre>
1.12 grr 268: # cd /usr
269: # cvs -q up -PAd src
1.1 deraadt 270: </pre>
271: Everytime you ran this it would syncronize your /usr/src tree. It would
272: not destroy any of your local changes, rather it would attempt to merge
273: changes in. If you use obj directories (not obj symbolic links) you may
274: wish to append "-I obj" to the cvs command line, this will keep cvs from
275: spitting out a warning about all the obj directories it is going to
276: encounter which are not in the repository.
277: </p>
278:
279: <p>
1.12 grr 280: or to make a diff of a locally patched module (here cd.c) to include with
281: a bug report:
282: <pre>
283: # cd /usr
284: # cvs diff -u src/sys/scsi/cd.c > /tmp/patch
285: </pre>
286: </p>
287:
288: <p>
1.1 deraadt 289: The CVS man page (included with the CVS sources) has much more
290: information about how CVS can be used.
291: </p>
292:
293: <p>
1.12 grr 294: <strong>Warning:</strong>
295: When using cvs you should take care that your current directory is either
296: the root of the tree you're referencing or in a separate place such as /tmp.
297: Some commands such as "get" can create an arbitrary sub-tree in the current
298: directory, and a subsequent update will recursively flesh out this sub-tree.
299: </p>
300:
301: <p>
1.1 deraadt 302: The anoncvs service gives fledgling developers a chance to learn CVS
303: operation and get thoroughly involved in the development process
304: before getting "commit" access -- as a result of showing useful
305: skills and high quality results they will naturally later be given
306: developer access. As well, people providing patches can create
307: their "diff"s relative to the CVS tree, which will ease integration.
308: </p>
309:
310: <p>
1.15 grr 311: <strong>Anoncvs: rsh vs. ssh</strong>
1.12 grr 312: <br>
313: By default, the CVS client uses rsh to talk to the CVS server. Many
314: of the CVS sites no longer supprt rsh for security reasons or a local
315: problem like a firewall or imperfect protocol emulator such as slirp
316: may prevent you from using rsh.
317: The alternative is a to use a "secure shell" connection using
318: <a href=http://www.cs.hut.fi/ssh>ssh</a>. This is a commerical product
319: offered by <a href=http://www.ssh.fi>SSH Communications Security Ltd</a>,
320: however they make a free unix version available that can be easily
321: installed under OpenBSD. You can download the unix version from
322: <a href=http://www.cs.hut.fi/ssh>http://www.cs.hut.fi/ssh</a> or one of
323: the mirrors listed there.
324: </p>
325: <p>
326: In this case,
1.1 deraadt 327: one sets the environment variable <strong>CVS_RSH</strong> to point
328: to ssh (typically <strong>/usr/local/bin/ssh</strong>). To reduce the
329: performance hit the anoncvs server would take it is recommended (and
330: requested) that you disable encryption. If your local site prevents
331: you from connecting out to port 22 (which ssh defaults to using) use
332: port 2022.
333: </p>
334:
335: <p>
336: Do not be tempted to turn on compression since CVS already compresses.
337: Use something like the following in your <strong>$HOME/.ssh/config</strong>
1.10 millert 338: file. Note that not all anoncvs servers allow ssh connections on
1.21 millert 339: port 2022. Also note that most anoncvs servers no longer accept
340: the <strong>none</strong> cipher as it is disabled in recent
341: versions of ssh for security reasons.
1.1 deraadt 342: </p>
343: <pre>
344: Host anoncvs.usa.openbsd.org
345: Port 2022
346: </pre>
347:
348: <p>
349: CVS is a little noisy starting up; to quiet it a bit you may want to
350: do this:
351: <pre>
352: setenv CVS_CLIENT_PORT -1
353: </pre>
354: </p>
355:
356: <p>
1.8 deraadt 357: If you wish to change from one CVS server to another (say your normal one is
358: down, or for any other reason), the environment variable which will let you
359: do this is
360: <pre>
361: setenv CVS_IGNORE_REMOTE_ROOT
362: </pre>
363: </p>
364:
365: <p>
1.1 deraadt 366: If you wish to be a new anoncvs mirror site, please contact the anoncvs
367: <a href=mailto:deraadt@theos.com>maintainer</a>.
368: Anoncvs mirrors require about 300MB of disk, and use up to 4MB of swap
369: per anoncvs user (assuming the user does a large operation; while smaller
370: operations use fewer resources, anoncvs still makes much more of an
371: impact than ftp or sup). Such anoncvs machines should have excellent
372: network connectivity for the area they are expected to serve. A
373: <a href=anoncvs.shar>document</a>
374: which describes the setup of anoncvs servers is available.
375: </p>
376:
377: </dl>
378:
379: <hr>
1.3 deraadt 380: <a href=index.html><img src=back.gif border=0 alt=OpenBSD></a>
1.1 deraadt 381: <a href=mailto:www@openbsd.org>www@openbsd.org</a>
1.22 ! niklas 382: <br><small>$OpenBSD: anoncvs.html,v 1.21 1997/06/22 21:01:24 millert Exp $</small>
1.1 deraadt 383:
384: </body>
385: </html>