Editing BZFlag CVS

BZFlag CVS, is the [http://en.wikipedia.org/wiki/Concurrent_Versions_System Concurrent Versions System] used by the development team to maintain and store the [[BZFlag Source]] code. The CVS system is hosted by [http://www.sourceforge.net 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.

==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 [http://www.tortoisecvs.org/ the Tortoise Graphical CVS Client].

==CVS Modules==
The source code in CVS is broken up into a number of modules for ease of use and other reasons.  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]], [[BZFS|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==
===Command line===
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.

===TortoiseCVS===

[[image:Tort_anon_cvs.png|right|thumb|400px|Tortoise Graphical CVS Client]] 

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==
===Command Line===
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'''.

===TortoiseCVS===
Windows users that use the Tortoise Graphical CVS Client, should enter the data shown here
[[Image:Tort_dev_cvs.png]]

Again the developer must use there SourceForge username.to login.

==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 a CVS client ([[BZFlag 2.2|v2.1]] at present).

===Tags===
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.8|v2.0.8]] is ''v2_0_8''

===Branches===
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 [[BZFlag 2.0.9|2.0.9]].

===Usage in CVS===
To receive the code from a branch or tag, the CVS client must be told what tag or branch to use. 

===Command Line===
users of the command line tool should add
{|
|
 -r ''TAG''
|}
after the '''co''' portion of the cvs command, but before the module name.

===TortoiseCVS===
Windows users that use the Tortoise Graphical CVS Client, would pick the tag from the revision tab, as shown here.
[[Image:Tort_cvs_tag.png]]

==External Links==
[http://sourceforge.net/cvs/?group_id=3248 SourceForge CVS Access page]

[http://bzflag.cvs.sourceforge.net/bzflag/ BZFlag CVS Tree]

[[Category:Development]]
[[Category:Compiling]]
[[Category:Versions]]