This wiki is archived and useful information is being migrated to the main bzflag.org website
BZFlag CVS
BZFlag CVS, is the Concurrent Versions System used by the development team to maintain and store the BZFlag Source code. The CVS system is hosted by SourceForge and is accessible by anyone with the proper software.
CVS has 2 methods of access, Anonymous ( or anon CVS ) for general users, and a SSH based Developer CVS, for project developers.
Contents
CVS clients
To access the source code via CVS, you will need a CVS client. Most unix/linux type operating systems have the command line CVS client as an installable option. Windows users must download a third party CVS client, such as the Tortoise Graphical CVS Client.
CVS Modules
The source code in CVS is broken up into a number of modules for ease of use. When requesting the source code from the CVS system the module must be specified to the CVS software.
The current CVS modules are:
- bzflag : The main module that includes the game client, server, plug-ins, and bzadmin.
- admin : The Master Ban list
- bzedit : The linux version of the BZFlag map editor BZEdit
- bzeditw32 : The windows version of the BZFlag map editor BZEditWin32
- web : The main website at http://www.bzflag.org
- db : Files related to the website http://my.bzflag.org and the Global Login system.
- tools : an abandoned cross platform version of BZEditWin32
- pybzflag : an abandoned python implementation of BZFlag
Anon CVS Access
SourceForge allows anonymous access to the CVS system on a read only basis. One does not need a SourceForge account to get a copy of the code via the Anon CVS system.
Users with a command line CVS tool can access the source by running 2 commands
cvs -d:pserver:anonymous@bzflag.cvs.sourceforge.net:/cvsroot/bzflag login
and
cvs -z3 -d:pserver:anonymous@bzflag.cvs.sourceforge.net:/cvsroot/bzflag co -P bzflag
If a different module is desired, simply replace bzflag in the second command with the desired module.
Windows users that use the Tortoise Graphical CVS Client, should enter the data shown here
Again if a different module is desired, simply replace the bzflag module name with the one desired.
Developer CVS Access
Project developers that need read and write access to the source code to make changes ( or commits ) need to use the SSH developer CVS. A sourceforge account is required for developer access, as well as approval from a project administrator.
Users with a command line CVS tool can access the source by running 2 commands
export CVS_RSH=ssh
and
cvs -z3 -d:ext:developername@bzflag.cvs.sourceforge.net:/cvsroot/bzflag co -P bzflag
The developer must enter there SourceForge username in place of developername.
Windows users that use the Tortoise Graphical CVS Client, should enter the data shown here
Tags and Branches
The BZFlag developers make use of tags and branches in CVS to separate the code for each version of the game. The current development version is always marked as HEAD in CVS and is the default code retrieved by CVS. Each major release will be marked with a tag in CVS so that it can be easily retrieved. The tags for each release are in the following format:
vX_Y_Z
where,
- X is the Major Version
- Y is the Minor Version
- Z is the Revision
The tag for the last release BZFlag 2.0.08 is v2_0_8
A branch for continuing development on each Minor version is kept in CVS as well. The format for the branches is:
vX_Ybranch
where again,
- X is the Major Version
- Y is the Minor Version
The branch for the development of 2.0.x is v2_0branch and is currently marked as version 2.0.9.
To receive the code from a branch or tag, the CVS client must be told what tag or branch to use.
users of the command line tool should add
-R TAG
after the co portion of the cvs command, but before the module name.
Windows users that use the Tortoise Graphical CVS Client, would pick the tag from the revision tab, as shown here.