$Id: README,v 1.13 2002/04/08 15:30:14 knu Exp $

- We have the following repository trees and modules:

/src/			... the "src" repository tree
	CVSROOT/
	ruby/		... the "ruby" module;
			    the reference implementation of Ruby and
			    standard modules
	rubicon/	... the "rubicon" module;
			    a test suite for the Ruby interpreter and
			    standard classes/modules
	app/		... the "app" module
		.../	... Ruby applications
	lib/		... the "lib" module
		.../	... Ruby libraries
	shim/		... the "shim" modules
			    A set of modules that provide new features
			    of Ruby to older versions
	rough/		... the "rough" module;
		.../	... standard-to-be Ruby libraries
	oniguruma/	... the "oniguruma" module;
			    a GNU regex compatible regular
			    expression library

	This repository is for the source files of Ruby and related
	modules.


- You can get a whole repository tree by demanding one of the cvs-*
collections.

cvs-src

- You can check out a snapshot of all modules except CVSROOT in a
repository tree by demanding one of the *-all collections.  Currently
*-all is virtually the same as * for some trees, but in the future we
may add extra modules to some of the trees and *-all collections will
cover them.

src-all

- You can check out a snapshot of a specific module by demanding one
of the other collections than mentioned above.

ruby		rubicon		shim
rough		oniguruma
src-app		src-lib

- OK, now you seem to know what you want.  Do as follows to do the
CVSup:

1. Grab a supfile (or more) you want in the directory:

	http://www.ruby-lang.org/cgi-bin/cvsweb.cgi/cvsup/supfiles/?cvsroot=admin

2. Fix the paths in it to match your environment.

3. Change "tag=." line (if any) if you want another branch than HEAD:
e.g. "tag=ruby_1_6", "date=2001.00.15.18:00:00", etc.

4. Run cvsup(1) with the supfile:
e.g. "cvsup -gL2 src-supfile", "cvsup -sgL2 cvs-doc-supfile", etc.

- If you are unable to do "cvs update" due to permission problems, try
adding the following line to your supfile(s):

	*default preserve

to preserve the files' permissions of the master, or this line:

	*default umask=002

to make your local mirror tree(s) group-writable.

- If you have any question with CVSup, consult cvsup(1) manpage:

	http://www.FreeBSD.org/cgi/man.cgi?query=cvsup&sektion=1&manpath=FreeBSD+Ports&format=html

or visit the following site for details:

	http://www.polstra.com/projects/freeware/CVSup/

- "CVSup" is pronounced "see vee supp". (from CVSup FAQ)

--
Akinori MUSHA <knu@ruby-lang.org>