• VRJ_2_0_ALPHA_4_BRANCH: A branch created for making the VR Juggler 2.0 Alpha 4 release. It was created from HEAD using the branch point VRJ_2_0_ALPHA_4_BRANCH_bp on April 28, 2004. This branch will allow a stable code base to be used for IPT 2004.

• VRJ_RELENG_2_0_BRANCH: The branch used for the VR Juggler 2.0.x release series. It was created from the HEAD branch using the branch point VRJ_RELENG_2_0_BRANCH_bp on June 6, 2005. The first release from this branch was VR Juggler 2.0 Beta 3.

• HEAD: The mainline branch being used to develop VR Juggler 2.1 (the code that will become VR Juggler 2.2). It was created from the juggler_1.0 HEAD branch in September 2001 when VR Juggler was separated into a more modular software system. The revision history from the juggler_1.0 module was preserved.

• VRJ_2_0_RELENG_BRANCH: The branch used for the VR Juggler 2.0.x release series. It was created from the HEAD branch using the branch point VRJ_2_0_RELENG_BRANCH_bp on June 6, 2005. The first release from this branch was VR Juggler 2.0 Beta 3.

• HEAD: The mainline branch being used to develop PyJuggler 1.1 (the code that will become PyJuggler 1.2).

• RELENG_1_0: The branch used for the PyJuggler 1.0.x release series, which is kept up to date with the VR Juggler 2.0.x release series.
• RELENG_0_7: The source used for PyJuggler 0.7.x, which corresponds with VR Juggler 2.0 Alpha 2 and Alpha 3. Changes from HEAD are merged to improve stability and multi-platform usability only.

• VRJ_2_0_ALPHA_4_BRANCH: A branch created for making the VR Juggler 2.0 Alpha 4 release. It was created from HEAD using the branch point VRJ_2_0_ALPHA_4_BRANCH_bp on April 28, 2004. This branch will allow a stable code base to be used for IPT 2004.

• VRJ_2_0_ALPHA_2_BRANCH: A branch created from the VR Juggler 2.0 Alpha 2 release tag. This branch was created July 3, 2003, from HEAD to allow a stable code base to be used for SIGGRAPH 2003 while also allowing the jccl_config_refactor_branch code to be merged back to HEAD. This branch was used to prepare the VR Juggler 2.0 Alpha 3 bug fix release.

Release Branches

In-Development Branches

(These have not yet been merged back to the branch from which they were created.)

Module: PyJuggler

Primary Branch

• HEAD: The mainline branch being used to develop PyJuggler^? 0.x (the code that will become PyJuggler^? 1.0).

Release Branches

(These exist to allow a given release to stabilize with bug fixes. Changes are normally merged from HEAD as appropriate.)

• RELENG_0_7: The source used for PyJuggler^? 0.7.x, which corresponds with VR Juggler 2.0 Alpha 2 and Alpha 3. Changes from HEAD are merged to improve stability and multi-platform usability only.

-- PatrickHartling - 15 Sep 2003

• VRJ_2_0_ALPHA_2_BRANCH: A branch created from the VR Juggler 2.0 Alpha 2 release tag. This branch was created July 3, 2003, from HEAD to allow a stable code base to be used for SIGGRAPH 2003 while also allowing the jccl_config_refactor_branch code to be merged back to HEAD. This branch is now being used to prepare the VR Juggler 2.0 Alpha 3 bug fix release.

• jccl_config_refactor_branch: This is (yet another) branch for work on refactoring the configuration infrastructrue. The work being done is happening in an effort to eliminate all the lingering carry-over "cruft" from the VR Juggler 1.0 configuration classes, both Java and C++. Many problems with the design of the code and the XML files have been identified in the creation of VRJConfig, and the work being done on this branch will fix things--hopefully once and for all. The branch was created from the HEAD branch June 10, 2003. It was merged back to HEAD July 10, 2003.

• jccl_config_refactor_branch: This is (yet another) branch for work on refactoring the configuration infrastructrue. The work being done is happening in an effort to eliminate all the lingering carry-over "cruft" from the VR Juggler 1.0 configuration classes, both Java and C++. Many problems with the design of the code and the XML files have been identified in the creation of VRJConfig, and the work being done on this branch will fix things--hopefully once and for all. The branch was created from the HEAD branch June 10, 2003.

• If instead, VR Juggler 3.0 is deemed "too far off," the following structure would be more appropriate:

--+------- HEAD (2.1) -----+------- HEAD (2.3)
   \                        \ 
    \                        \---- VRJ_RELENG_2_2_BRANCH (2.2)
     \ 
      \---- VRJ_RELENG_2_0_BRANCH (2.0)

• RIM_REFACTOR_POST_SC02: The branch used for developing the third-generation clustering software used by VR Juggler. It was branched from HEAD in mid-December 2002. It was merged back to HEAD February 25, 2003.

• VRJ_DEV_RELEASE_3_BRANCH: The branch used to stabilize the VR Juggler 1.1 code base for the third developer release (DR3) while work towrads DR4 continued. It was branched from HEAD using the branch point VRJ_DEV_RELEASE_3_BP. It was merged back to HEAD September 30, 2002.

• jccl_tweek_conversion_branch: The branch used for the initial porting of VjControl to use Tweek and JavaBeans for component management and loading. This branch was created from HEAD using the branch point jccl_tweek_conversion_BP. It was merged back to HEAD June 16, 2002.

• jccl_tweek_conversion2_branch: The branch used for the second phase of creating a JCCL file editor that plugs into Tweek. It was branched from HEAD using the branch point jccl_tweek_conversion2_BP. It was merged back to HEAD July 16, 2002.

• RIM_REFACTOR_BRANCH: The branch being used to refactor the Gadgeteer Remote Input Manager. It was created off HEAD from the branch point RIM_REFACTOR_BRANCH_BP. It was merged back to HEAD July 9, 2002.

• When creating a branch point tag, use the same name as the branch but add a "_bp" suffix to the name. This will allow easy correlation between branches and branch points.
• Commands for creating branch and branch points:

  cvs ....
  cvs ....

Module: juggler_1.0

Primary Branch

• RELENG_1_0: The VR Juggler 1.0 release branch. All VR Juggler 1.0 releases are made from the code on this branch. This branch was created from the HEAD at the branch point RELENG_1_0_BP, created January 9, 2001. This branch shares a branch point with RELENG_0_2 (see below).

Defunct Branches

• HEAD: The now-defunct VR Juggler 1.1 development code. This branch is no longer in use. Please refer to the HEAD branch in the juggler module. The last version of VR Juggler on this branch was version 1.1.87.
• RELENG_0_2: The short-lived branch that would have been used to release VR Juggler 0.2 after the initial 0.1.x beta releases. It was created from HEAD using the branch point RELENG_0_2_BP December 13, 2000, but it was abandoned when we decided that the code was ready for a 1.0 release. All code on this branch was merged to RELENG_1_0 when it was created. Both branches were branched from the same point, but the actual tags used reflect the branch name.
• r0_1_163-vjcontrol_exp: The branch used to modularize VjControl and to create a component-loading system similar to JavaBeans^?. It was created from the HEAD branch November 20, 2000, and merged back into the HEAD in mid-May 2001.
• patrick_nspr: The branch used to add NSPR support to the operating system abstraction. This branch also resulted in the creation of what is now VPR. It was created from the HEAD branch at the branch point patrick_nspr_BP. Its contents were merged back into the HEAD branch February 17, 2001.
• r0_1_186_input_mgr_refactor: The branch used to refactor the Input Manager. It was created in early January 2001 and was merged back to the HEAD branch February 5, 2001.
• r1_1_23_xmlconfig: The branch used for the first implementation of XML-based configuration files. It was created in late May 2001 and was merged back into HEAD in late August 2001.

Branch Overview

Spelling Conventions

• Those branches in all capital letters (RELENG_1_0) are branches used for releasing code. Those branches with lower-case letters are use for "experimental" or work-in-progress code that could break the build or the functionality of the system.
  • NOTE: Not all branches conform to these conventions as they were not formalized until this document was written.
• The use of underscores (_) is preferred over hyphens (-) as a word separator.

Branch Creation

• It is strongly recommended that branches be created using a branch point tag, though this is not strictly required because some developers do not feel the need for the initial tag.

Module: juggler_1.0

Primary Branch

• RELENG_1_0: The VR Juggler 1.0 release branch. All VR Juggler 1.0 releases are made from the code on this branch. This branch was created from the HEAD at the branch point RELENG_1_0_BP, created January 9, 2001. This branch shares a branch point with RELENG_0_2 (see below).

Defunct Branches

• HEAD: The now-defunct VR Juggler 1.1 development code. This branch is no longer in use. Please refer to the HEAD branch in the juggler module. The last version of VR Juggler on this branch was version 1.1.87.
• RELENG_0_2: The short-lived branch that would have been used to release VR Juggler 0.2 after the initial 0.1.x beta releases. It was created from HEAD using the branch point RELENG_0_2_BP December 13, 2000, but it was abandoned when we decided that the code was ready for a 1.0 release. All code on this branch was merged to RELENG_1_0 when it was created. Both branches were branched from the same point, but the actual tags used reflect the branch name.
• r0_1_163-vjcontrol_exp: The branch used to modularize VjControl and to create a component-loading system similar to JavaBeans^?. It was created from the HEAD branch November 20, 2000, and merged back into the HEAD in mid-May 2001.
• patrick_nspr: The branch used to add NSPR support to the operating system abstraction. This branch also resulted in the creation of what is now VPR. It was created from the HEAD branch at the branch point patrick_nspr_BP. Its contents were merged back into the HEAD branch February 17, 2001.
• r0_1_186_input_mgr_refactor: The branch used to refactor the Input Manager. It was created in early January 2001 and was merged back to the HEAD branch February 5, 2001.
• r1_1_23_xmlconfig: The branch used for the first implementation of XML-based configuration files. It was created in late May 2001 and was merged back into HEAD in late August 2001.

Module: juggler

Primary Branches

• HEAD: The mainline branch being used to develop VR Juggler 1.1 (the code that will become VR Juggler 2.0). It was created from the juggler_1.0 HEAD branch in September 2001 when VR Juggler was separated into a more modular software system. The revision history from the juggler_1.0 module was preserved.
• RELENG_1_DOCS: This branch contains DocBook versions of all VR Juggler 1.0 documentation (no code). It is maintained here to allow easy merging from the mainline branch when appropriate.

In-Development Branches

(These have not yet been merged back to the branch from which they were created.)

• RIM_REFACTOR_BRANCH: The branch being used to refactor the Gadgeteer Remote Input Manager. It was created off HEAD from the branch point RIM_REFACTOR_BRANCH_BP.
• jccl_tweek_conversion2_branch: The branch used for the second phase of creating a JCCL file editor that plugs into Tweek. It was branched from HEAD using the branch point jccl_tweek_conversion2_BP.

Defunct Branches

• remote_input_eric: This branch was used for a short time in December 2001 when the Gadgeteer Remote Input Manager was initially brought into the source tree.
• gmtl_conversion-branch: The branch used to port Gadgeteer and VR Juggler to the new math library, GMTL. It was created from the HEAD branch in mid-March 2002; it was merged back to HEAD April 10, 2002.
• jccl_file_format_change_branch: The branch used to develop JCCL 0.2.0. It was created off HEAD from the branch point jccl_file_format_change_bp. This has been merged to the HEAD.
• jccl_tweek_conversion_branch: The branch used for the initial porting of VjControl to use Tweek and JavaBeans^? for component management and loading. This branch was created from HEAD using the branch point jccl_tweek_conversion_BP. It was merged back to HEAD June 16, 2002.

Future Branches

• The following diagram is the proposed branch structure for the VR Juggler 2 release line and the continued development towards VR Juggler 3.0. The VRJ_RELENG_2_BRANCH branch will be created as the code is stabilized for the VR Juggler 2.0 release. Once the release is finalized, the VRJ_RELENG_2_0_BRANCH branch will be created. On this branch, only bug fixes and minor additions (new device drivers, for example) will be allowed. Bug fixes and API-compatible new features will be allowed on VRJ_RELENG_2_BRANCH as it progresses towards VR Juggler 2.2.

--+-------------------------- HEAD (3.0)
   \ 
    +-(2.1)-+--(2.3)-- VRJ_RELENG_2_BRANCH
     \       \ 
      \       \------ VRJ_RELENG_2_2_BRANCH (2.2)
       \ 
        \---- VRJ_RELENG_2_0_BRANCH (2.0)

-- PatrickHartling - 22 Jun 2002