Update VCS instructions for Git
authorRuss Allbery <rra@stanford.edu>
Tue, 30 Mar 2010 05:17:31 +0000 (22:17 -0700)
committerDerrick Brashear <shadow@dementia.org>
Tue, 30 Mar 2010 13:20:01 +0000 (06:20 -0700)
Rename README.CVS to README.GIT and update the references from CVS
to GIT.  Refer readers to the wiki for the detailed instructions and
information about Gerrit.

Change-Id: Ia1826110c4b974ab36a64555ca44e6c5ce74f7ef
Reviewed-on: http://gerrit.openafs.org/1667
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>

README.CVS [deleted file]
README.GIT [new file with mode: 0644]

diff --git a/README.CVS b/README.CVS
deleted file mode 100644 (file)
index 73790bc..0000000
+++ /dev/null
@@ -1,50 +0,0 @@
-The CVS tree may not always have code which can currently be built.
-While every effort is made to keep the head of the tree buildable,
-you may at any time find yourself between commits and hence have a tree
-which does not build, or worse, causes more serious problems!
-Do not use the CVS tree unless you know what you're doing.
-CVS snapshots do not include files generated by autoconf; You can
-run regen.sh (at the top level) to create these files. You will need
-to have autoconf and automake installed on your system.
-Using CVS
-      CVSROOT:                :pserver:anonymous@cvs.openafs.org:/cvs
-      password:               anonymous
-1. Obtain the CVS software. Go to http://www.cvshome.org
-2. Set the environment variable CVSROOT to the CVSROOT listed above, e.g.
-      (csh)  setenv CVSROOT :pserver:anonymous@cvs.openafs.org:/cvs
-      (sh)   CVSROOT=:pserver:anonymous@cvs.openafs.org:/cvs; export CVSROOT
-      (dos)  set CVSROOT=:pserver:anonymous@cvs.openafs.org:/cvs
-3. Run the following commands:  
-   % cvs login 
-       When prompted for the password, use the password listed above.
-   % cvs checkout openafs
-   % ./regen.sh
-After this command completes there will be an openafs subdirectory
-with the latest sources.
-Useful commands are "cvs update", "cvs diff', "cvs log". Refer to the
-CVS documentation for more details and options.
-Note that you can not do the "cvs commit" as an anonymous user.
-Code changes may be sent to: 
-      openafs-bugs@openafs.org (private list)
-      openafs-devel@openafs.org (public list)
diff --git a/README.GIT b/README.GIT
new file mode 100644 (file)
index 0000000..380a138
--- /dev/null
@@ -0,0 +1,60 @@
+The Git tree may not always have code which can currently be built.
+While every effort is made to keep the head of the tree buildable,
+you may at any time find yourself between commits and hence have a tree
+which does not build, or worse, causes more serious problems!
+Do not use the Git tree unless you know what you're doing.
+Git checkouts do not include files generated by autoconf. You can
+run regen.sh (at the top level) to create these files. You will need
+to have autoconf and automake installed on your system.
+Browse:  http://git.openafs.org/
+Clone:   git clone git://git.openafs.org/openafs.git
+1. Obtain the Git software. If you are using a system with a standard
+   software repository, Git may already be available as a package named
+   something like git or git-core.  Otherwise, go to http://git-scm.com/
+2. Run the command:
+   % git clone git://git.openafs.org/openafs.git
+   This will download the full repository and leave a checked-out tree in
+   a subdirectory of the current directory named openafs. The repository
+   itself is in the .git subdirectory of that directory.
+   WARNING: The repository is approximately 60MiB currently and will only
+   grow, so it may take some time to download the first time over a slow
+   network connection.
+3. Generate the additional required files:
+   % cd openafs
+   % ./regen.sh
+The current development series is in the branch named master. The stable
+releases are on separate branches named something like
+openafs-stable_<version> with a separate branch for each major stable
+release series. Use git branch -a to see a full list of branches.
+OpenAFS uses the Gerrit code review system to review and merge all changes
+to OpenAFS. More details are at:
+    http://www.dementia.org/twiki/bin/view/AFSLore/GitDevelopers
+including more detailed Git instructions.
+It's by far preferred to use Gerrit to submit code changes, but if you
+can't for whatever reason, you can instead open a bug and submit a patch
+that way. Do this by sending mail to openafs-bugs@openafs.org with the
+patch attached. But please use Gerrit if you can; patches sent in as bugs
+will have to be forwarded to Gerrit by someone else, and it's easier for
+everyone if you can enter them into Gerrit yourself.