2
2
.. into HTML or text. In the future we plan to extract the example commands
3
3
.. and automatically test them.
5
.. This text was previously on the wiki at
5
.. This text was previously on the wiki at
6
6
.. http://bazaar.canonical.com/IntroductionToBzr
7
7
.. but has been moved into the source tree so it can be kept in sync with
8
8
.. the source and possibly automatically checked.
14
Current for bzr-0.91, 2007-08
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
34
36
important information that you would desperately like to get back. If this
35
37
has ever happened to you, then you are probably ready for Bazaar.
37
Version control systems (which I'll henceforth call VCS) such as
39
Revision control systems (which I'll henceforth call RCS) such as
38
40
Bazaar give you the ability to track changes for a directory by turning
39
41
it into something slightly more complicated than a directory that we call
40
42
a **branch**. The branch not only stores how the directory looks right
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
52
54
optional log message. Real life log messages include things like "Fixed
53
the web template to close the table" and "Added SFTP suppport. Fixes #595"
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
72
control work. This can be a bit of a problem if your server is on some other
71
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
92
Revision control software such as Bazaar can do much more than just
91
93
storage and performing undo. For example, with Bazaar a developer can
92
94
take the modifications in one branch of software and apply them to a
93
95
related branch -- even if those changes exist in a branch owned by
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
110
subcommand of this. You can get some help with ``bzr help``. Some arguments
109
111
are grouped in topics: ``bzr help topics`` to see which topics are available.
111
113
One function of a version control system is to keep track of who changed
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.
122
To set a global identity, use::
124
% bzr whoami "Your Name <email@example.com>"
126
If you'd like to use a different address for a specific branch, enter
127
the branch folder and use::
129
% bzr whoami --branch "Your Name <email@example.com>"
131
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
132
adding the following lines. Please note that ``[DEFAULT]`` is case
136
email=Your Name <email@isp.com>
138
As above, you can override this settings on a branch by branch basis
139
by creating a branch section in ``~/.bazaar/locations.conf`` and
140
adding the following lines::
142
[/the/path/to/the/branch]
143
email=Your Name <email@isp.com>
146
#. Overriding the two previous options by setting the global environment
147
variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
148
precedence) to your full email address.
148
150
.. [1] On Windows, the users configuration files can be found in the
149
151
application data directory. So instead of ``~/.bazaar/branch.conf``
150
the configuration file can be found as:
152
the configuration file can be found as:
151
153
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
152
154
The same is true for ``locations.conf``, ``ignore``, and the
153
155
``plugins`` directory.
210
212
You'll usually refer to branches on your computer's filesystem just by
211
213
giving the name of the directory containing the branch. bzr also supports
212
accessing branches over SSH, HTTP and SFTP, amongst other things::
214
accessing branches over http and sftp, for example::
214
% bzr log bzr+ssh://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/
215
% bzr log http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/
216
% bzr log sftp://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/
216
% bzr log http://bazaar-vcs.org/bzr/bzr.dev/
217
% bzr log sftp://bazaar-vcs.org/bzr/bzr.dev/
218
219
By installing bzr plugins you can also access branches using the rsync
231
232
its test suite before committing, to make sure that every revision is a
232
233
known-good state. You can also review your changes, to make sure you're
233
234
committing what you intend to, and as a chance to rethink your work before
234
you permanently record it.
235
you permanently record it.
236
Two bzr commands are particularly useful here: **status** and **diff**.
237
Two bzr commands are particularly useful here: **status** and **diff**.
278
279
Some projects prefer patches to show a prefix at the start of the path
279
280
for old and new files. The ``--prefix`` option can be used to provide
281
As a shortcut, ``bzr diff -p1`` produces a form that works with the
282
As a shortcut, ``bzr diff -p1`` produces a form that works with the
282
283
command ``patch -p1``.
285
285
Committing changes
286
286
==================
288
288
When the working tree state is satisfactory, it can be **committed** to
289
the branch, creating a new revision holding a snapshot of that state.
289
the branch, creating a new revision holding a snapshot of that state.
331
331
commit message when you have finished. If you would like parts to be
332
332
included in the message you can copy and paste them above the separator.
334
Marking bugs as fixed
335
---------------------
337
Many changes to a project are as a result of fixing bugs. Bazaar can keep
338
metadata about bugs you fixed when you commit them. To do this you use the
339
``--fixes`` option. This option takes an argument that looks like this::
341
% bzr commit --fixes <tracker>:<id>
343
Where ``<tracker>`` is an identifier for a bug tracker and ``<id>`` is an
344
identifier for a bug that is tracked in that bug tracker. ``<id>`` is usually
345
a number. Bazaar already knows about a few popular bug trackers. They are
346
bugs.launchpad.net, bugs.debian.org, and bugzilla.gnome.org. These trackers
347
have their own identifiers: lp, deb, and gnome respectively. For example,
348
if you made a change to fix the bug #1234 on bugs.launchpad.net, you would
349
use the following command to commit your fix::
351
% bzr commit -m "fixed my first bug" --fixes lp:1234
353
For more information on this topic or for information on how to configure
354
other bug trackers please read `Bug Tracker Settings`_.
356
.. _Bug Tracker Settings: ../user-reference/index.html#bug-tracker-settings
379
355
given then only those ones will be affected. ``bzr revert`` also clears the
380
356
list of pending merges revisions.
389
361
Many source trees contain some files that do not need to be versioned,
390
362
such as editor backups, object or bytecode files, and built programs. You
391
363
can simply not add them, but then they'll always crop up as unknown files.
428
400
% bzr commit -m "Add ignore patterns"
434
As an alternative to editing the ``.bzrignore`` file, you can use the
435
``bzr ignore`` command. The ``bzr ignore`` command takes filenames and/or
436
patterns as arguments and then adds them to the ``.bzrignore`` file. If a
437
``.bzrignore`` file does not exist the ``bzr ignore`` command will
438
automatically create one for you, and implicitly add it to be versioned::
445
Just like when editing the ``.bzrignore`` file on your own, you should
446
commit the automatically created ``.bzrignore`` file::
448
% bzr commit -m "Added tags to ignore file"
454
406
There are some ignored files which are not project specific, but more user
507
459
directory. This is a bit different to CVS, which requires that you also
508
460
do ``cvs remove``.
510
``bzr remove`` makes the file un-versioned, but may or may not delete the
511
working copy [2]_. This is useful when you add the wrong file, or decide that
512
a file should actually not be versioned.
462
``bzr remove`` makes the file un-versioned, but may or may not delete
463
the working copy [2]_. This is useful when you add the wrong file,
464
or decide that a file should actually not be versioned.
557
509
After this change, the local directory will be a mirror of the source. This
558
includes the ''revision-history'' - which is a list of the commits done in
510
includes the ''revision-history'' - which is a list of the commits done in
559
511
this branch, rather than merged from other branches.
561
513
This command only works if your local (destination) branch is either an
618
570
uses rsync to push the changes to the revision history and the working
621
* You can also copy the files around manually, by sending a tarball, or using
622
rsync, or other related file transfer methods. This is usually less safe
623
than using ``push``, but may be faster or easier in some situations.
626
Moving changes between trees
573
You can also use copy the files around manually, by sending a tarball, or
574
using rsync, or other related file transfer methods. This is usually
575
less safe than using ``push``, but may be faster or easier in some
578
Moving changes between trees
627
579
============================
629
581
It happens to the best of us: sometimes you'll make changes in the wrong
added
removed
doc/en/tutorials/tutorial.txt
