14
Current for bzr-0.8, 2006-04
18
If you are already familiar with decentralized version control, then
20
If you are already familiar with decentralized revision control, then
19
21
please feel free to skip ahead to "Introducing Yourself to Bazaar". If,
20
on the other hand, you are familiar with version control but not
21
decentralized version control, then please start at "How DVCS is
22
on the other hand, you are familiar with revision control but not
23
decentralized revision control, then please start at "How DRCS is
22
24
different." Otherwise, get some coffee or tea, get comfortable and get
25
The purpose of version control
26
==============================
27
The Purposes of Revision Control
28
================================
28
30
Odds are that you have worked on some sort of textual data -- the sources
29
31
to a program, web sites or the config files that Unix system
42
44
do something you wish you hadn't, you can restore the directory to the way
43
45
it looked at some point in the past.
45
Version control systems give users the ability to save changes to a
47
Revision control systems give users the ability to save changes to a
46
48
branch by "committing a **revision**". The revision created is essentially
47
49
a summary of the changes that were made since the last time the tree was
50
52
These revisions have other uses as well. For example, one can comment
51
53
revisions to record what the recent set of changes meant by providing an
53
55
the web template to close the table" and "Added sftp suppport. Fixes #595"
55
57
We keep these logs so that if later there is some sort of problem with
56
sftp, we can figure out when the problem probably happened.
61
Many Version Control Systems (VCS) are stored on servers. If one wants to
62
work on the code stored within a VCS, then one needs to connect to the
58
sftp, we can figure out when the problem probably happened.
63
Many Revision Control Systems (RCS) are stored on servers. If one wants to
64
work on the code stored within an RCS, then one needs to connect to the
63
65
server and "checkout" the code. Doing so gives one a directory in which a
64
person can make changes and then commit. The VCS client then connects to
65
the VCS server and stores the changes. This method is known as the
66
person can make changes and then commit. The RCS client then connects to
67
the RCS server and stores the changes. This method is known as the
68
The centralized model can have some drawbacks. A centralized VCS requires
70
The centralized model can have some drawbacks. A centralized RCS requires
69
71
that one is able to connect to the server whenever one wants to do version
70
control work. This can be a bit of a problem if your server is on some other
71
machine on the internet and you are not. Or, worse yet, you **are** on the
72
control work. This can be a bit of a problem if your server on some other
73
machine on the internet and you are not. Or, worse yet, you ''are'' on the
72
74
internet but the server is missing!
74
Decentralized Version Control Systems (which I'll call DVCS after this
76
Decentralized Revision Control Systems (which I'll call DRCS after this
75
77
point) deal with this problem by keeping branches on the same machine as
76
78
the client. In Bazaar's case, the branch is kept in the same place as
77
79
the code that is being version controlled. This allows the user to save
79
81
user only needs internet access when he wants to access the changes in
80
82
someone else's branch that are somewhere else.
83
85
A common requirement that many people have is the need to keep track of
84
86
the changes for a directory such as file and subdirectory changes.
85
87
Performing this tracking by hand is a awkward process that over time
86
88
becomes unwieldy. That is, until one considers version control tools such
87
89
as Bazaar. These tools automate the process of storing data by creating
88
a **revision** of the directory tree whenever the user asks.
90
a **revision** of the directory tree whenever the user asks.
90
Version control software such as Bazaar can do much more than just
91
storage and performing undo. For example, with Bazaar a developer can
92
take the modifications in one branch of software and apply them to a
93
related branch -- even if those changes exist in a branch owned by
94
somebody else. This allows developers to cooperate without giving
95
write access to the repository.
92
Revision control software such as Bazaar can do much more than just
93
storage and performing undo. For example, with Bazaar developer can
94
take the modifications in one branch of software and apply them to
95
another, related, branch -- even if those changes exist in a branch owned
96
by somebody else. This allows developers to cooperate without giving write
97
99
Bazaar remembers the ''ancestry'' of a revision: the previous revisions
98
100
that it is based upon. A single revision may have more than one direct
105
107
==============================
107
109
Bazaar installs a single new command, **bzr**. Everything else is a
108
subcommand of this. You can get some help with ``bzr help``. Some arguments
109
are grouped in topics: ``bzr help topics`` to see which topics are available.
110
subcommand of this. You can get some help with `bzr help`. There will be
111
113
One function of a version control system is to keep track of who changed
112
114
what. In a decentralized system, that requires an identifier for each
113
115
author that is globally unique. Most people already have one of these: an
114
email address. Bazaar is smart enough to automatically generate an email
116
email address. Bzr is smart enough to automatically generate an email
115
117
address by looking up your username and hostname. If you don't like the
116
118
guess that Bazaar makes, then three options exist:
118
1. Set an email address via ``bzr whoami``. This is the simplest way.
120
To set a global identity, use::
122
% bzr whoami "Your Name <email@example.com>"
124
If you'd like to use a different address for a specific branch, enter
125
the branch folder and use::
127
% bzr whoami --branch "Your Name <email@example.com>"
129
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
130
adding the following lines. Please note that ``[DEFAULT]`` is case
134
email=Your Name <email@isp.com>
136
As above, you can override this settings on a branch by branch basis
137
by creating a branch section in ``~/.bazaar/locations.conf`` and
138
adding the following lines::
140
[/the/path/to/the/branch]
141
email=Your Name <email@isp.com>
144
#. Overriding the two previous options by setting the global environment
145
variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
146
precedence) to your full email address.
120
1. Set an email address via ``bzr whoami``. This is the simplest way.
121
To set a global identity, use::
123
% bzr whoami 'Your Name <email@example.com>'
125
If you'd like to use a different address for a specific branch, enter
126
the branch folder and use::
128
% bzr whoami --branch 'Your Name <email@example.com>'
130
1. Setting the email address in the
131
``~/.bazaar/bazaar.conf`` [1]_ by adding the following lines. Please note that
132
``[DEFAULT]`` is case sensitive::
135
email= Your Name <email@isp.com>
137
As above, you can override this settings on a branch by branch basis by
138
creating a branch section in ``~/.bazaar/locations.conf`` and adding the
141
[/the/directory/to/the/branch]
142
email=Your Name <email@isp.com>
144
1. Overriding the two previous options by setting the global environment
145
variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
146
to your full email address.
148
148
.. [1] On Windows, the users configuration files can be found in the
149
149
application data directory. So instead of ``~/.bazaar/branch.conf``
150
the configuration file can be found as:
150
the configuration file can be found as:
151
151
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
152
152
The same is true for ``locations.conf``, ``ignore``, and the
153
153
``plugins`` directory.
155
155
Creating a branch
156
156
=================
158
History is by default stored in the .bzr directory of the branch. In a
159
future version of Bazaar, there will be a facility to store it in a
160
separate repository, which may be remote.
162
We create a new branch by running ``bzr init`` in an existing directory::
158
History is by default stored in the .bzr directory of the branch. There
159
will be a facility to store it in a separate repository, which may be
160
remote. We create a new branch by running **bzr init** in an existing
184
185
% bzr add hello.txt
191
If you add the wrong file, simply use ``bzr remove`` to make it
192
unversioned again. This does not delete the working copy in this case,
193
though it may in others [2]_.
195
.. [2] ``bzr remove`` will remove the working copy if it is currently
196
versioned, but has no changes from the last committed version. You
197
can force the file to always be kept with the ``--keep`` option to
198
``bzr remove``, or force it to always be deleted with ``--force``.
190
If you add the wrong file, simply use **bzr remove** to make it
191
unversioned again. This does not delete the working copy.
203
196
All history is stored in a branch, which is just an on-disk directory
204
197
containing control files. By default there is no separate repository or
205
198
database as used in svn or svk. You can choose to create a repository if
206
you want to (see the ``bzr init-repo`` command). You may wish to do this
207
if you have very large branches, or many branches of a moderately sized
199
you want to (see the **bzr init-repo** command). You may wish to do this
200
if you have very large branches, or many branches of a moderate sized
210
203
You'll usually refer to branches on your computer's filesystem just by
211
204
giving the name of the directory containing the branch. bzr also supports
212
accessing branches over http and sftp, for example::
205
accessing branches over http, for example::
214
207
% bzr log http://bazaar-vcs.org/bzr/bzr.dev/
215
% bzr log sftp://bazaar-vcs.org/bzr/bzr.dev/
217
By installing bzr plugins you can also access branches using the rsync
220
See the `Publishing your branch`_ section for more about how to put your
221
branch at a given location.
209
By installing bzr plugins you can also access branches over the sftp or
223
212
Reviewing changes
224
213
=================
230
219
its test suite before committing, to make sure that every revision is a
231
220
known-good state. You can also review your changes, to make sure you're
232
221
committing what you intend to, and as a chance to rethink your work before
233
you permanently record it.
222
you permanently record it.
235
Two bzr commands are particularly useful here: **status** and **diff**.
224
Two bzr commands are particularly useful here: **status** and **diff**.
256
245
''patch'', ''diffstat'', ''filterdiff'' and ''colordiff''::
259
=== added file 'hello.txt'
260
--- hello.txt 1970-01-01 00:00:00 +0000
261
+++ hello.txt 2005-10-18 14:23:29 +0000
248
*** added file 'hello.txt'
266
With the ``-r`` option, the tree is compared to an earlier revision, or
255
With the ''-r'' option, the tree is compared to an earlier revision, or
267
256
the differences between two versions are shown::
269
258
% bzr diff -r 1000.. # everything since r1000
270
259
% bzr diff -r 1000..1100 # changes from 1000 to 1100
272
The ``--diff-options`` option causes bzr to run the external diff program,
261
The --diff-options option causes bzr to run the external diff program,
273
262
passing options. For example::
275
264
% bzr diff --diff-options --side-by-side foo
277
Some projects prefer patches to show a prefix at the start of the path
278
for old and new files. The ``--prefix`` option can be used to provide
280
As a shortcut, ``bzr diff -p1`` produces a form that works with the
266
Some projects prefer patches to show a prefix at the start of the path for
267
old and new files. The --prefix option can be used to provide such a prefix.
268
As a shortcut, ``bzr diff -p1`` produces a form that works with the
281
269
command ``patch -p1``.
284
271
Committing changes
285
272
==================
287
274
When the working tree state is satisfactory, it can be **committed** to
288
the branch, creating a new revision holding a snapshot of that state.
275
the branch, creating a new revision holding a snapshot of that state.
302
289
% bzr commit -m "added my first file"
304
You can also use the ``-F`` option to take the message from a file. Some
291
You can also use the -F option to take the message from a file. Some
305
292
people like to make notes for a commit message while they work, then
306
293
review the diff to make sure they did what they said they did. (This file
307
294
can also be useful when you pick up your work after a break.)
309
296
Message from an editor
310
----------------------
297
======================
312
If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
299
If you use neither the `-m` nor the `-F` option then bzr will open an
313
300
editor for you to enter a message. The editor to run is controlled by
314
your ``$VISUAL`` or ``$EDITOR`` environment variable, which can be overridden
315
by the ``editor`` setting in ``~/.bazaar/bazaar.conf``; ``$BZR_EDITOR`` will
316
override either of the above mentioned editor options. If you quit the
317
editor without making any changes, the commit will be cancelled.
319
The file that is opened in the editor contains a horizontal line. The part
320
of the file below this line is included for information only, and will not
321
form part of the commit message. Below the separator is shown the list of
322
files that are changed in the commit. You should write your message above
323
the line, and then save the file and exit.
325
If you would like to see the diff that will be committed as you edit the
326
message you can use the ``--show-diff`` option to ``commit``. This will include
327
the diff in the editor when it is opened, below the separator and the
328
information about the files that will be committed. This means that you can
329
read it as you write the message, but the diff itself wont be seen in the
330
commit message when you have finished. If you would like parts to be
331
included in the message you can copy and paste them above the separator.
333
Marking bugs as fixed
334
---------------------
336
Many changes to a project are as a result of fixing bugs. Bazaar can keep
337
metadata about bugs you fixed when you commit them. To do this you use the
338
``--fixes`` option. This option takes an argument that looks like this::
340
% bzr commit --fixes <tracker>:<id>
342
Where ``<tracker>`` is an identifier for a bug tracker and ``<id>`` is an
343
identifier for a bug that is tracked in that bug tracker. ``<id>`` is usually
344
a number. Bazaar already knows about a few popular bug trackers. They are
345
bugs.launchpad.net, bugs.debian.org, and bugzilla.gnome.org. These trackers
346
have their own identifiers: lp, deb, and gnome respectively. For example,
347
if you made a change to fix the bug #1234 on bugs.launchpad.net, you would
348
use the following command to commit your fix::
350
% bzr commit -m "fixed my first bug" --fixes lp:1234
352
For more information on this topic or for information on how to configure
353
other bug trackers please read `Bug Tracker Settings`_.
355
.. _Bug Tracker Settings: ../user-reference/index.html#bug-tracker-settings
301
your `$EDITOR` environment variable or
302
add `editor` to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will override
303
the above mentioned editor options. If you quit the editor without
304
making any changes, the commit will be cancelled.
374
323
If you've made some changes and don't want to keep them, use the
375
324
**revert** command to go back to the previous head version. It's a good
376
idea to use ``bzr diff`` first to see what will be removed. By default the
325
idea to use **bzr diff** first to see what will be removed. By default the
377
326
revert command reverts the whole tree; if file or directory names are
378
given then only those ones will be affected. ``bzr revert`` also clears the
327
given then only those ones will be affected. **revert** also clears the
379
328
list of pending merges revisions.
388
333
Many source trees contain some files that do not need to be versioned,
389
334
such as editor backups, object or bytecode files, and built programs. You
390
335
can simply not add them, but then they'll always crop up as unknown files.
391
336
You can also tell bzr to ignore these files by adding them to a file
392
called ``.bzrignore`` at the top of the tree.
337
called ''.bzrignore'' at the top of the tree.
394
339
This file contains a list of file wildcards (or "globs"), one per line.
395
340
Typical contents are like this::
402
347
If a glob contains a slash, it is matched against the whole path from the
403
348
top of the tree; otherwise it is matched against only the filename. So
404
349
the previous example ignores files with extension ``.o`` in all
405
subdirectories, but this example ignores only ``config.h`` at the top level
350
subdirectories, but this example ignores only config.h at the top level
406
351
and HTML files in ``doc/``::
411
356
To get a list of which files are ignored and what pattern they matched,
412
use ``bzr ignored``::
357
use ''bzr ignored''::
415
360
config.h ./config.h
427
372
% bzr commit -m "Add ignore patterns"
433
As an alternative to editing the ``.bzrignore`` file, you can use the
434
``bzr ignore`` command. The ``bzr ignore`` command takes filenames and/or
435
patterns as arguments and then adds them to the ``.bzrignore`` file. If a
436
``.bzrignore`` file does not exist the ``bzr ignore`` command will
437
automatically create one for you, and implicitly add it to be versioned::
444
Just like when editing the ``.bzrignore`` file on your own, you should
445
commit the automatically created ``.bzrignore`` file::
447
% bzr commit -m "Added tags to ignore file"
453
378
There are some ignored files which are not project specific, but more user
466
The ``bzr log`` command shows a list of previous revisions. The ``bzr log
467
--forward`` command does the same in chronological order to get most
391
The **bzr log** command shows a list of previous revisions. The **bzr log
392
--forward** command does the same in chronological order to get most
468
393
recent revisions printed at last.
470
As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
395
As with bzr diff, bzr log supports the -r argument::
472
397
% bzr log -r 1000.. # Revision 1000 and everything after it
473
398
% bzr log -r ..1000 # Everything up to and including r1000
505
430
You can delete files or directories by just deleting them from the working
506
431
directory. This is a bit different to CVS, which requires that you also
509
``bzr remove`` makes the file un-versioned, but may or may not delete the
510
working copy [2]_. This is useful when you add the wrong file, or decide that
511
a file should actually not be versioned.
434
**bzr remove** makes the file un-versioned, but does not delete
435
the working copy. This is useful when you add the wrong file, or decide
436
that a file should actually not be versioned.
533
458
Often rather than starting your own project, you will want to submit a
534
change to an existing project. To do this, you'll need to get a copy of
535
the existing branch. Because this new copy is potentially a new branch,
536
the command is called **branch**::
459
change to an existing project. You can get a copy of an existing branch
460
by copying its directory, expanding a tarball, or by a remote copy using
461
something like rsync. You can also use bzr to fetch a copy. Because this
462
new copy is potentially a new branch, the command is called *branch*::
538
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
464
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
541
467
This copies down the complete history of this branch, so we can do all
542
468
operations on it locally: log, annotate, making and merging branches.
543
469
There will be an option to get only part of the history if you wish.
545
You can also get a copy of an existing branch by copying its directory,
546
expanding a tarball, or by a remote copy using something like rsync.
548
471
Following upstream changes
549
472
==========================
578
If there is a conflict during a merge, 3 files with the same basename
579
are created. The filename of the common base is appended with ".BASE",
580
the filename of the file containing your changes is appended with
581
".THIS" and the filename with the changes from the other tree is
582
appended with ".OTHER". Using a program such as kdiff3, you can now
583
comfortably merge them into one file. In order to commit you have to
584
rename the merged file (".THIS") to the original file name. To
585
complete the conflict resolution you must use the resolve command,
586
which will remove the ".OTHER" and ".BASE" files. As long as there
587
exist files with .BASE, .THIS or .OTHER the commit command will
592
% kdiff3 file.BASE file.OTHER file.THIS
501
If there is a conflict during a merge, 3 files with the same basename are
502
created. The filename of the common base is appended with .BASE, the
503
filename of the file containing your changes is appended .THIS and the
504
filename with the changes from the other tree is appended .OTHER.
505
Using a program such as kdiff3, you can now comfortably merge them into
506
one file. To commit you have to rename it to the original basename and
507
delete the other two files. As long as there exist files with .BASE, .THIS
508
or .OTHER the commit command will complain.
596
510
[**TODO**: explain conflict markers within files]
604
518
directory. One can push a branch (or the changes for a branch) by one of
605
519
the following three methods:
607
* The best method is to use bzr itself to do it.
611
% bzr push sftp://servername.com/path/to/directory
613
(The destination directory must already exist unless the
614
``--create-prefix`` option is used.)
616
* Another option is the ``rspush`` plugin that comes with BzrTools, which
617
uses rsync to push the changes to the revision history and the working
620
* You can also copy the files around manually, by sending a tarball, or using
621
rsync, or other related file transfer methods. This is usually less safe
622
than using ``push``, but may be faster or easier in some situations.
625
Moving changes between trees
626
============================
628
It happens to the best of us: sometimes you'll make changes in the wrong
629
tree. Maybe because you've accidentally started work in the wrong directory,
630
maybe because as you're working, the change turns out to be bigger than you
631
expected, so you start a new branch for it.
633
To move your changes from one tree to another, use
638
% bzr merge --uncommitted OLDDIR
640
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
641
It will not apply committed changes, even if they could be applied to NEWDIR
642
with a regular merge. The changes will remain in OLDDIR, but you can use ``bzr
643
revert OLDDIR`` to remove them, once you're satisfied with NEWDIR.
645
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
646
The more different they are, the greater the chance of conflicts.
521
* Rsync: rsync -avrz LOCALBRANCH servername.com/this/directory/here
523
(or any other tool for publishing a directory to a web site.)
525
* bzr push sftp://servername.com/this/directory/here
527
(The directory that must already exist)
529
* The rspush plugin that comes with BzrTools
added
removed
doc/tutorial.txt
