Changes between Version 10 and Version 11 of GitRepo

Timestamp:

05/01/2013 06:00:03 PM (10 years ago)

Author:

Cas

Comment:

more detail about branches

GitRepo

@@ -1 @@
-= Git Source Repository =
+= Git Source Code Repository =
 
-Deluge's source code is always available through our [http://git.deluge-torrent.org/ Git repository].
+Deluge's source code is always available through our [http://git.deluge-torrent.org/deluge Git repository].
 
 To get a copy of the code, you will need to clone it from the repository then see the [wiki:'Installing/Source' Installation Guide].
 
-For more in depth-git usage see GitTips and GitCommit.
+For more in-depth git usage see GitTips and GitCommit.
 
-If you are on Windows, you will need a [http://en.wikipedia.org/wiki/Git_%28software%29#Portability Git client]. This guide uses commands which are meant to be typed at a command prompt, but most of the same commands would be available from a graphical Git client or shell extension. If you wish to use the commands in this guide, you will need a command-line client such as [https://code.google.com/p/msysgit/downloads/list?can=3&q=official+Git Git for Windows] from the msysgit project.
+This guide uses commands which are meant to be typed at a command prompt, but most will be available from a GUI Git client.
+
+[http://git-scm.com/downloads Install Git]
+
+
+
+== Deluge Branches ==
+There are multiple branches or tags that you can choose from which contain different stages of the Deluge code.
+
+Note that we are currently transitioning to a different [http://nvie.com/posts/a-successful-git-branching-model/ git workflow] with the development of ''1.4'' so picking the correct branch is crucial.
+
+The current branches (at time of writing) are:
+
+ '''`1.3-stable`''':: 
+    This is the release branch for the 1.3-series and, until 1.4 release, is the recommended stable code. This branch is only for critical bug fixes and no new feature will appear in this branch. 
+ '''`master`'''::
+    '''''This branch is in limbo until 1.4 release''''' This branch contains development code that is now continued in `develop`. When the `develop` code is considered stable, 1.4 will be released and the code will be merged back into `master` code. This mean going forward from 1.4 release this branch will be considered to be the most stable code, replacing the use of *-stable branches.
+ '''`develop`'''::
+    All development work will be put into this branch and should be considered unstable with risk of data loss and potential incompatibility with other Deluge versions.
+ '''`extjs4-port`'''::
+   A branch for porting the WebUI code from `Ext JS 3.4` to `Ext JS 4`, still requiring a lot of development work.
 
 == Initial Clone ==
@@ -19 +39 @@
 This will create a ''deluge'' directory with a copy of the repo so if you change into this directory you can start using git commands. 
 
-== Selecting Branch ==
 
-There are multiple branches or tags that you can choose from, but the main two are the current stable branch and the development branch.  
+== Select Branch ==
 
 List the branches, including remote branches:
@@ -29 +48 @@
 }}}
 
-If you want to use a different branch than the default selected (''master'') then you will need to create a local copy of the remote branch. In this example we create branch '1.3-stable' as a local copy of the remote branch 'origin/1.3-stable' and switch to it:
+== Switch Branch ==
+
+If you want to use a different branch than the default selected (`master`) then you will need to create a local copy of the remote branch. In this example we create branch '1.3-stable' as a local copy of the remote branch 'origin/1.3-stable' and switch to it:
 
 {{{
@@ -39 +60 @@
  '''Development:'''
 {{{
-git checkout master
+git checkout develop
 }}}
 
@@ -47 +68 @@
 }}}
 
+== Show current Branch ==
 Either of these commands will show the current branch you are using: