~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/organizing_branches.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-30 05:43:20 UTC
  • mfrom: (3054.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20071130054320-b4oer0rcbiy2ouzg
Bazaar User Guide for 1.0rc (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Organizing branches
 
2
===================
 
3
 
 
4
Mirror branches
 
5
---------------
 
6
 
 
7
A primary difference when using distributed workflows to
 
8
develop is that your main local branch is not the place
 
9
to make changes. Instead, it is kept as a pristine copy
 
10
of the central branch, i.e. it's a *mirror branch*.
 
11
 
 
12
To create a mirror branch, set-up a shared repository
 
13
(if you haven't already) and then use the ``branch``
 
14
(or ``checkout``) command to create the mirror.
 
15
For example::
 
16
 
 
17
  bzr init-repo X-repo
 
18
  cd X-repo
 
19
  bzr branch sftp://centralhost/srv/bzr/X-repo/X-trunk
 
20
 
 
21
Task branches
 
22
-------------
 
23
 
 
24
Each new feature or fix is developed in its own branch.
 
25
These branches or referred to as *feature branches * or
 
26
*task branches* - the terms are used interchangably.
 
27
 
 
28
To create a task branch, use the ``branch`` command
 
29
against your mirror branch. For example::
 
30
 
 
31
  bzr branch X-trunk X-fix-123
 
32
  cd X-fix-123
 
33
  (hack, hack, hack)
 
34
 
 
35
There are numerous advantages to this approach:
 
36
 
 
37
 1. You can work on multiple changes in parallel
 
38
 2. There is reduced coupling between changes
 
39
 3. Multiple people can work in a peer-to-peer mode
 
40
    on a branch until it is ready to go.
 
41
 
 
42
In particular, some changes take longer to cook than others
 
43
so you can ask for reviews, apply feedback, ask for another
 
44
review, etc. By completing work to sufficient quality in
 
45
separate branches before merging into a central branch, the
 
46
quality and stability of the central branch are maintained
 
47
at higher level than they otherwise would be.
 
48
 
 
49
Refreshing a mirror branch
 
50
--------------------------
 
51
 
 
52
Use the ``pull`` command to do this::
 
53
 
 
54
  cd X-trunk
 
55
  bzr pull
 
56
 
 
57
Merging the latest trunk into a feature branch
 
58
----------------------------------------------
 
59
 
 
60
Use the ``merge`` command to do this::
 
61
 
 
62
  cd X-fix-123
 
63
  bzr merge
 
64
  (resolve any conflicts)
 
65
  bzr commit -m "merged X-trunk"
 
66
 
 
67
Merging a feature into the trunk
 
68
--------------------------------
 
69
 
 
70
The policies for different distributed workflows vary here.
 
71
The simple case where all developers have commit rights to
 
72
the main trunk are shown below.
 
73
 
 
74
If your mirror is a checkout::
 
75
 
 
76
  cd X-trunk
 
77
  bzr update
 
78
  bzr merge ../X-fix-123
 
79
  (resolve any conflicts)
 
80
  bzr commit -m "Fixed bug #123"
 
81
 
 
82
If your mirror is a branch::
 
83
 
 
84
  cd X-trunk
 
85
  bzr pull
 
86
  bzr merge ../X-fix-123
 
87
  (resolve any conflicts)
 
88
  bzr commit -m "Fixed bug #123"
 
89
  bzr push
 
90
 
 
91
Backing up task branches
 
92
------------------------
 
93
 
 
94
One of the side effects of centralized workflows is that changes
 
95
get frequently committed to a central location which is backed up as
 
96
part of normal IT operations. When developing on task branches,
 
97
it is a good idea to publish your work to a central location
 
98
(but not necessarily a shared location) that will be backed up.
 
99
You may even wish to bind local task branches to remote ones
 
100
established on a backup server just for this purpose.