Prev	Chapter�13.� CVS Guidelines -	Next

Using CVS with OpenACS

Getting Started

Using CVS with OpenACS

Getting Started

All OpenACS code is available anonymously. To get code anonymously, use the parameter -d:pserver:anonymous@openacs.org:/cvsroot immediately after cvs in a cvs command to check out or export code. @@ -40,47 +40,47 @@ You may want to set some more default actions for CVS usage. To do so, create the file ~/.cvsrc with the contents: -

cvs -z6
-cvs -q

-z6 speeds up cvs access over the network quite a bit by enabling compressed - connection by default. -q suppresses some verbose output from commands. For example, it makes the output of cvs up much easier to read.

Administrator Note: These are the steps to grant CVS commit rights to a user:

Create the user's account. On openacs.org:

sudo bash
-/usr/sbin/useradd -c "Real Name" -G cvs,username -p passwd username

Grant cvs access to the user account. On any machine, in a temporary directory:

cvs -d :ext:openacs.org:/cvsroot co CVSROOT +

cvs -z6
+cvs -q

-z6 speeds up cvs access over the network quite a bit by enabling compressed + connection by default. -q suppresses some verbose output from commands. For example, it makes the output of cvs up much easier to read.

Branimir suggests an additional level of abstraction. If you put

Host cvs-server
+emacs avail

Add an avail line of the form:

avail|username|openacs-4

cvs commit -m "added commit on X for username" avail

Branimir suggests an additional level of abstraction. If you put

Host cvs-server
       HostName openacs.org
-      User yournamehere

into your ~/.ssh/config file, then you can use -d :ext:cvs-server:/cvsroot instead of -d :ext:openacs.org:/cvsroot. You can then change the definition of cvs-server by changing one file instead of editing hundreds of CVSROOT/Repository files.

Checkout for Package Development

If you are actively developing a non-core package, you + User yournamehere

Checkout for Package Development

If you are actively developing a non-core package, you should work from the latest core release branch. Currently this is oacs-5-1. This ensures that you are working on top of a stable OpenACS core, but still allows you to commit feature - changes to non-core packages. To check out all packages,

cvs -d :ext:openacs.org:/cvsroot co -r oacs-5-1 openacs-4

If you work in the directories created with this command, all of your + changes to non-core packages. To check out all packages,

cvs -d :ext:openacs.org:/cvsroot co -r oacs-5-1 openacs-4

If you work in the directories created with this command, all of your cvs updates and commits will be confined to the oacs-5-1 branch. Your work will be merged back to HEAD for you with each release.

Because the entire openacs-4 directory is large, you may want to use only acs-core plus some specific modules. To do - this, check out core first:

cvs -d:ext:openacs.org:/cvsroot -r oacs-5-1 checkout acs-core

Then add modules as needed:

cd /var/lib/aolserver/service0/packages
-cvs up -d packagename

... where packagename is the name of the + this, check out core first:

cvs -d:ext:openacs.org:/cvsroot -r oacs-5-1 checkout acs-core

Then add modules as needed:

cd /var/lib/aolserver/service0/packages
+cvs up -d packagename

... where packagename is the name of the package you want. Visit the Package Inventory for a list of available packages and their current state. -

Checkout for Core Development

If you are actively developing packages in the OpenACS +

Checkout for Core Development

If you are actively developing packages in the OpenACS Core, work from the HEAD branch. HEAD is used for active development of the next version of core OpenACS. It may be very buggy; it may not even install correctly. Do not use this branch for development of non-core features unless your work depends on some of the HEAD core work. To check out HEAD, omit the - -r tag.

To check out HEAD for development, which requires an OpenACS developer account:

cvs -d:ext:openacs.org:/cvsroot checkout acs-core

To check out HEAD anonymously:

cvs -d:pserver:anonymous@openacs.org:/cvsroot checkout acs-core

Checkout .LRN

+ -r tag.

To check out HEAD for development, which requires an OpenACS developer account:

cvs -d:ext:openacs.org:/cvsroot checkout acs-core

To check out HEAD anonymously:

cvs -d:pserver:anonymous@openacs.org:/cvsroot checkout acs-core

Checkout .LRN

.LRN consists of a given version openacs core, plus a set of packages. These are collectively packages together to form a distrubution of .LRN. F .LRN 2.0.0 sits on top of OpenACS 5.0.0. .LRN also uses an OpenACS install.xml file during installation; this file is distributed within the dotlrn package and must be moved. To get a development checkout of .LRN in the subdirectory dotlrn: -

cvs -d :pserver:anonymous@openacs.org:/cvsroot checkout -r oacs-5-1 acs-core +

cvs -d :pserver:anonymous@openacs.org:/cvsroot checkout -r oacs-5-1 acs-core
 mv openacs-4 dotlrn
 cd dotlrn/packages
 cvs -d :pserver:anonymous@openacs.org:/cvsroot checkout -r oacs-5-1 dotlrn-all
-mv dotlrn/install.xml ..

Working with CVS

+mv dotlrn/install.xml ..

Working with CVS

Once you have a checkout you can use some commands to track what has changed since you checked out your copy. cvs -n update does not change any files, but reports which changes have been updated or locally modified, or are not present in CVS.

To update your files, use cvs update. This will merge changes from the repository with your local files. It has no effect on the openacs.org repository.