[Boa Constr] Boa CVS tutorial

[Riaan B. <riaan@e.co.za>]

Hello everybody, I've updated Boa's help on CVS Explorer.

The updated document should answer all recent questions and hopefully
make the CVS facilities less mysterious.

Hope this helps.
--

CVS browsing and operations are supported.


Requirements

Command-line CVS has to be installed and working before CVS
operations will work in Boa. CVS operations are implemented as a
thin wrapper on top of command line cvs. You should therefor have
a working knowledge of cvs before using this facility.
CVS over SSH is also supported, but only if keys are used and
created with empty passphrases.

Command-line CVS requires the following:
* cvs.exe for Windows, available from
  http://ftp.cvshome.org/win32/cvs1-11.zip on Linux cvs is part of
  most standard distributions.
* The file cvs.exe must be on the system path ($PATH).
* The $HOME environment variable be defined to point at a valid
  directory.

On Windows NT environment variables can be set from My
Computer->Properties-Environment
On Win9x environment variables can be set in AUTOEXEC.BAT.
e.g. Say your cvs.exe is in C:\CVSBIN and you have a directory
called C:\HOME, you should add

PATH=%PATH%;C:\CVSBIN
HOME=C:\HOME

to the end of your AUTOEXEC.BAT file.


Checking out a local copy

In any directory in the Explorer, right click and choose
CVS->Login to log in to a CVS repository.
Fill in the repository's CVSROOT, e.g.:
:pserver:ano...@cv...:/cvsroot/boa-constructor

Next you will be prompted for a password. For anonymous CVS access
to Boa the password is empty, just press enter. This information
is saved in .cvspass in the home directory ($HOME).

To checkout, right click and choose CVS->Checkout. On the given
command line, change [MODULE] to the module you want to check out.
For Boa this is boa.
Also pass the CVSROOT with parameter -d if your $CVSROOT
environment variable is not defined.
e.g. (one line) cvs -z7 -d
:pserver:ano...@cv...:/cvsroot/boa-constructor
checkout -P boa


Browsing/Working on a local copy

Enter the cyan CVS directory of an already checked out module in
the Explorer to view the CVS status of the files.
These directories are created by CVS when a project is checked out
of a CVS repository.

The selection determines which files are passed to CVS on the
command line. When nothing is selected the the current directory
'.' (the one selected in the tree) is used.
The following CVS commands are supported:

* Update
* Commit
* Add
* Add binary
* Remove
* Diff
* Log
* Status
* Tag
* Branch

Right click on the selection and choose a CVS command from the
popup menu or from the toolbar.
A confirmation dialog showing the help for your command and the
command line that will be executed. Edit the command line if
needed.
Results for stderr (Errors and Server messages) is shown in a
message dialog, and results on stdout is shown is a multiline text
control.

If you need to use SSH, SSH has to be setup to use the public and
private keys generated with ssh-keygen and an empty passphrase.

-- 
Riaan Booysen
___________________________________________________
Boa Constructor - RAD GUI building IDE for wxPython
     http://boa-constructor.sourceforge.net