bitweaverCVS

Developer Management of bitweaver Source Code

Created by: btodoroff, Last modification: 26 Mar 2008 (15:37 UTC) by spiderr

Our CVS is hosted at Sourceforge. Usage information is in Section F of their documentation page. If you like, take a look at our groovy stats. And now, how Bitweaver CVS is organized:

Our CVS tree has one module for each package. However, a virtual module is use to create three primary distributions: bitweaver, bitweaverdev and bitweavercore. Every bitweaver release has a CVS branch named after it. The branch is created after we have gone into schema freeze for the project. For details on how to get code (checkout modules, branches, packages) please refer to this page: GetCode.

CVS Modules


Main modules

  • bitweaver - release material. These are the packages that are ready for general distribution.
  • bitweaverdev - all bitweaver packages that are currently available in CVS. Contains dangerously explosive stuff. Some packages are in serious flux and are not considered ready for general consumption. Gives you an idea of what great stuff is going to be available in the near future!
  • bitweavercore - contains all core modules without any clutter. Basically the minimum required to get a fully working version of bitweaver without any additional functionality.
  • packages - packages that were developed specifically for bitweaver are prepended with _bit_. For instance, the wiki package is called _bit_wiki in cvs. Third party applications such as phpBB are only prepended with an underscore, so to check out phpBB you check out _phpbb.

Other modules

  • _adodb - the latest import and merge of the adodb library supported by bitweaver
  • _smarty - the latest import and merge of the smarty library supported by bitweaver

To get a reliable list of all available modules and things that are available in CVS, please check out CVSROOT and view the modules file. There you can find the various modules and what virtual modules we have available and what exaclty they contain. To get the latest and greatest code from cvs HEAD, don't use any tags at all. For details, please refer to this page: GetCode.

CVS Branches

  • R# - R1 is equivalent to Release 1 and symbolises a stable release branch that will not undergo any API changes or database schema changes.
  • HEAD - no guarantees for stability provided. Might break at any time. There's no official support for this branch (still, you're welcome to join us on IRC if you have questions). Use this branch only if you are a developer.

(NOTE: As of 2007-11-19, HEAD is considered stable as we have released ReleaseTwo, but have not yet created an R2 branch)

As discussed in ReleaseProcess there are three active branches in CVS: STABLE, TESTING, and DEVELOPMENT. See ReleaseProcess for which branch is currently in which state.

Development/HEAD

DEVELOPMENT is the CVS trunk also known as HEAD. Fixes in STABLE get merged into TESTING as needed. Fixes in TESTING, including those from STABLE, get merged into HEAD as needed. Several tags are maintained on DEVELOPMENT, TESTING, and STABLE to manage the merge process. In general you should simple checkout the latest version of the brach you are working on. See ReleaseProcess for what should be done where.

Format:
  • Branch - Comment
    • Tag - Comment
    • Tag - Comment

HEAD - Current Mainline

This is the leading edge of development.

ReleaseOne R1

This is the version running on serveral sites and is considered stable. No database changes are made to this version and we try and maintain a stable environment.

Notes


Checkout bitweaver code

Pleaser refer to this page: GetCode.

Adding a package to R#


<?php
    cvs rtag 
-b R# <package>
    
e.g.: cvs rtag -b R1 _bit_calendar
?>


Including 3rd party code in CVS

Please refer to UsingLibrariesInCVS. There you find an example (adoDB) for including 3rd party code in CVS.

Importing new packages into CVS Modules

If you you are reworking a module from or Features Boneyard to be included in bitweaver, you are importing a new package into CVS Modules:
  1. delete all CVS directories from the package.
  2. cd into the package directory you wish to import
  3. import the package:
    
    <?php
    cvs -qz5 -d:ext:bitweaver@bitweaver.cvs.sf.net:/cvsroot/bitweaver import -m'IMPORT TikiPro CLYDE FINAL' _bit_sample BITWEAVER HEAD
    ?>
  4. add the module and alias to CVSROOT/modules and append to modules alias bitweaverdev

Changing branch for specific CVS modules

If you move a package from HEAD into release module, you need to change branch for a specific CVS module:
  1. modify CVSROOT/modules that the package is in the release module bitweaver
  2. cd to the module for which you want to change the branch tag
  3. cvs tag -R -b <branch>
  4. cvs up -r <branch>
  5. cvs commit
  6. to make sure it worked, you can remove the package dir and checkout the package again:
  7. optional: cvs co -r <branch><cvs module="">

How a release branch is created

In directory:


cvs -d:ext:..... co bitweaver

In /bitweaver directory:


cvs update -dP
cvs rtag -b -D <Today's Date Plus 1 Year: YYYY-MM-DD> <Release> bitweaver
cvs rtag -r <Release> <Release>_LASTMERGE bitweaver


Version Merging


How merge to HEAD is done


In R1/bitweaver directory


<?php
  1
cvs update -dP
  2
cvs tag -cF R1_NEXTMERGE
?>


In merge/HEAD directory:


<?php
  1
cvs -:ext:btodoroff@bitweaver.cvs.sourceforge.net:/cvsroot/bitweaver co bitweaver
  2
cd bitweaver
  3
cvs update -j R1_LASTMERGE -j R1_NEXTMERGE
  4
cvs commit -"Merge recent changes from R1 into HEAD"
  
5cd ..
  
6rm -rf bitweaver
  7
__Back in R1/bitweaver directory:__
  8
cvs tag -r R1_NEXTMERGE -F R1_LASTMERGE
?>


NOTE about the -kk option: There is one major caveat with using `-kk' on merges. Namely, it overrides whatever keyword expansion mode CVS would normally have used. In particular, this is a problem if the mode had been `-kb' for a binary file. Therefore, if your repository contains binary files, you will need to deal with the conflicts rather than using `-kk'

Merging using Meld

Make sure you have Meld installed: Fedora Core: # yum -y install meld and then get R1 and HEAD into seperate directories:


<?php
cvs 
-:ext:<username>@bitweaver.cvs.sourceforge.net:/cvsroot/bitweaver co -d biteaver_R1 -r R1 bitweaver
cvs 
-:ext:<username>@bitweaver.cvs.sourceforge.net:/cvsroot/bitweaver co -d biteaver_HEAD bitweaver
?>

Open meld, activate the CVS text filter in the preferences window, click on the new icon and select the 2 dirs: in the compare directories tab select bitweaver_R1 as the Mine directory and the bitweaver_HEAD directory as the Original directory. Merge the two, and commit to CVS. I don't think any tags are needed in CVS if this method is used, but i might be mistaken.</cvs></branch></branch></branch>

Related Items

Documentation » Technical Documentation

Documentation geared towards developers and people who want to learn about the core processes of bitweaver

  •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •    •