11
This document describes a possible workflow for using Bazaar_. That of
12
using Bazaar_, the distributed version control system, in a centralized
13
manner. Bazaar_ is designed to be very flexible and allows several
14
different workflows, from fully decentralized to mostly centralized. The
15
workflow used here is meant to ease a new user into more advanced usage of
16
Bazaar_, and allows them to work in a mix of centralized and decentralized
19
In general, this document is meant for users coming from a background of
20
centralized version control systems such as CVS or subversion. It is
21
common in work settings to have a single central server hosting the
22
codebase, with several people working on this codebase, keeping their work
23
in sync. This workflow is also applicable to a single developer working
24
on several different machines.
26
.. _Bazaar: http://bazaar-vcs.org
34
These are some reasonably simple steps to setup Bazaar_ so that it works
41
Your user identity is stored with each commit. While this doesn't have to
42
be accurate or unique, it will be used in log messages and
43
annotations, so it is better to have something real.
47
% bzr whoami "John Doe <jdoe@organization.com>"
50
Setting up a local Repository
51
-----------------------------
53
Bazaar_ branches generally copy the history information around with them,
54
which is part of how you can work in a fully decentralized manner. As an
55
optimization, it is possible for related branches to combine their storage
56
needs so that you do not need to copy around all of this history
57
information whenever you create a new branch.
59
The best way to do this is to create a `Shared Repository`_. In general,
60
branches will share their storage if they exist in a subdirectory of a
61
`Shared Repository`_. So let's setup a `Shared Repository`_ in our home
62
directory, thus all branches we create underneath will share their history
67
% bzr init-repo --trees ~
70
Setting up a remote Repository
71
---------------------------------
73
Many times you want a location where data is stored separately from where
74
you do your work. This workflow is required by centralized systems
75
(CVS/SVN). Usually they are on separate machines, but not always. This is
76
actually a pretty good setup, especially in a work environment. Since it
77
ensures a central location where data can be backed up, and means that if
78
something happens to a developer's machine, no committed work has to be
81
So let's set up a shared location for our project on a remote machine
82
called ``centralhost``. Again, we will use a
83
`Shared Repository`_ to optimize disk usage.
87
% bzr init-repo --no-trees sftp://centralhost/srv/bzr/
89
You can think of this step as similar to setting up a new cvsroot, or
90
subversion repository.
93
Versioning an existing project
94
==============================
96
Now that we have a repository, let's create a versioned project. Most of
97
the time, you will already have some code that you are working with,
98
that you now want to version using Bazaar_. If the code was originally
99
in source control, there are many ways to convert the project to Bazaar_
100
without losing any history. However, this is outside the scope of this
101
document. See `Tracking Upstream`_ for some possibilities (section
102
"Converting and keeping history").
104
.. _Tracking Upstream: http://bazaar-vcs.org/TrackingUpstream
107
XXX: We really need a different document for discussing conversion of a
108
project. Right now TrackingUpstream is the best we have, though.
111
Developer 1: Creating the first revision
112
----------------------------------------
114
So first, we want to create a branch in our remote Repository, where we
115
will want to host the project. Let's assume we have a project named
116
"sigil" that we want to start versioning.
120
% bzr init sftp://centralhost/srv/bzr/sigil
122
This can be thought of as the "HEAD" branch in CVS terms, or as the "trunk"
123
in Subversion terms. We will call this the ``dev`` branch.
125
I prefer working in a subdirectory of my home directory to avoid collisions with all
126
the other files that end up there. Also, we will want a project
127
directory where we can hold all of the different branches we end up
137
% bzr checkout sftp://centralhost/srv/bzr/sigil dev
141
% bzr commit -m "Initial import of Sigil"
144
In the example above, we created an empty branch (the ``/sigil`` branch)
145
on ``centralhost``, and then checkout out this empty branch onto our
146
workstation to add files from our existing project.
147
There are many ways to setup your working directory, but the steps above
148
make it easy to handle working with feature/bugfix branches. And one
149
of the strong points of Bazaar_ is how well it works with branches.
151
At this point, because you have a 'checkout' of the remote branch, any
152
commits you make in ``~/work/sigil/dev/`` will automatically be saved both locally,
153
and on ``centralhost``.
156
Developer N: Getting a working copy of the project
157
--------------------------------------------------
159
Since the first developer did all of the work of creating the project,
160
all other developers would just checkout that branch. **They should
161
still follow** `Setting User Email`_ and `Setting up a local Repository`_.
163
To get a copy of the current development tree::
166
% bzr checkout sftp://centralhost/srv/bzr/sigil dev
168
Now that two people both have a checkout of
169
``sftp://centralhost/srv/bzr/sigil``, there will be times when one of
170
the checkouts will be out of date with the current version.
171
At commit time, Bazaar_ will inform the user of this and prevent them from
172
committing. To get up to date, use ``bzr update`` to update the
173
tree with the remote changes. This may require resolving conflicts, if the
174
same files have been modified.
177
Developing on separate branches
178
===============================
180
So far everyone is working and committing their changes into the same
181
branch. This means that everyone needs to update fairly regularly and
182
deal with other people's changes. Also, if one person commits something
183
that breaks the codebase, then upon syncing, everyone will get the
186
Usually, it is better to do development on different branches, and then
187
integrate those back into the main branch, once they are stable. This is
188
one of the biggest changes from working with CVS/SVN. They both allow you
189
to work on separate branches, but their merging algorithms are fairly
190
weak, so it is difficult to keep things synchronized. Bazaar_ tracks
191
what has already been merged, and can even apply changes to files that
195
Creating and working on a new branch
196
------------------------------------
198
We want to keep our changes available for other people, even if they
199
aren't quite complete yet. So we will create a new public branch on
200
``centralhost``, and track it locally.
205
% bzr branch sftp://centralhost/srv/bzr/sigil \
206
sftp://centralhost/srv/bzr/sigil/doodle-fixes
207
% bzr checkout sftp://centralhost/srv/bzr/sigil/doodle-fixes doodle-fixes
210
We now have a place to make any fixes we need to ``doodle``. And we would
211
not interrupt people who are working on other parts of the code. Because
212
we have a checkout, any commits made in the ``~/work/sigil/doodle-fixes/``
213
will also show up on ``centralhost``. [#nestedbranches]_ It is also
214
possible to have 2 developers collaborate on one of these branches, just
215
like they would have collaborated on the ``dev`` branch. [#cbranch]_
217
.. [#nestedbranches] It may look odd to have a branch in a subdirectory of
218
another branch. This is just fine, and you can think of it as a
219
heirarchial namespace. Where the nested branch is derived from the
222
.. [#cbranch] When using lots of independent branches, having to retype
223
the full URL all the time takes a lot of typing. We are looking into
224
various methods to help with this, such as branch aliases, etc. For
225
now, though, the bzrtools_ plugin provides the ``bzr cbranch`` command.
226
Which is designed to take a base branch, create a new public branch,
227
and create a checkout of that branch, all with much less typing.
228
Configuring ``cbranch`` is outside the scope of this document, but the
229
final commands look like ``bzr cbranch dev my-feature-branch``
231
.. _bzrtools: https://launchpad.net/products/bzrtools
237
When it is decided that some of the changes in ``doodle-fixes`` are ready
238
to be merged into the main branch, simply do::
240
% cd ~/work/sigil/dev
241
% bzr merge ../doodle-fixes
243
Now the changes are available in the ``dev`` branch, but they have not
244
been committed yet. This is the time when you want to review the final
245
changes, and double check the code to make sure it compiles cleanly and
246
passes the test suite. The commands ``bzr status`` and ``bzr diff`` are
247
good tools to use here. Also, this is the time to resolve any conflicts.
248
Bazaar_ will prevent you from committing until you have resolved these
249
conflicts. That way you don't accidentally commit the conflict markers.
250
The command ``bzr status`` will show the conflicts along with the other
251
changes, or you can use ``bzr conflicts`` to just list conflicts. Use
252
``bzr resolve file/name`` or ``bzr resolve --all`` once conflicts have
253
been handled. [#resolve]_ If you have a conflict that is particularly
254
difficult to solve you may want to use the ``bzr remerge`` command. It
255
will let you try different merge algorithms, as well as let you see the
256
original source lines (``--show-base``).
258
.. [#resolve] Some systems make you resolve conflicts as part of the merge
259
process. We have found that it is usually easier to resolve conflicts
260
when you have the view of the entire tree, rather than just a single
261
file. It gives you much more context, and also lets you run tests as
262
you resolve the problems.
265
Recommended Branching
266
---------------------
268
One very common way to handle all of these branches is to give each
269
developer their own branch, and their own place to work in the central
270
location. This can be done with::
272
% bzr branch sftp://centralhost/srv/bzr/sigil \
273
sftp://centralhost/srv/bzr/sigil/user-a
274
% bzr branch sftp://centralhost/srv/bzr/sigil \
275
sftp://centralhost/srv/bzr/sigil/user-b
277
This gives each developer their own branch to work on. And, they can
278
easily create a new feature branch for themselves with just[#cbranch]_::
280
% bzr branch sftp://centralhost/srv/bzr/sigil/user-a \
281
sftp://centralhost/srv/bzr/sigil/user-a/feature
283
% bzr checkout sftp://centralhost/srv/bzr/sigil/user-a/feature myfeature
292
Bazaar_ has the concept of a "Shared Repository". This is similar to the
293
concept of other RCS's repository. Such as in Subversion, where you have a
294
remote repository, which is where all of the history is stored, and
295
locally you don't have any history information, only a checkout of the
296
working tree files. Note that "Shared" in this context means shared
297
between branches. It *may* be shared between people, but standalone
298
branches can also be shared between people.
300
In Bazaar_ terms, a "Shared Repository" is a location where multiple
301
branches can **share** their revision history information. Because Bazaar_
302
wants to support decentralized workflows, it is possible for every branch
303
to maintain its own revision history information. But this is often
304
inefficient, since related branches share history, and they might as well
305
share the storage as well.
309
vim: tw=74 ft=rst spell spelllang=en_us
added
removed
doc/centralized_workflow.txt
