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
20
If you are already familiar with decentralized revision control, then
18
If you are already familiar with decentralized version control, then
21
19
please feel free to skip ahead to "Introducing Yourself to Bazaar". If,
22
on the other hand, you are familiar with revision control but not
23
decentralized revision control, then please start at "How DRCS is
20
on the other hand, you are familiar with version control but not
21
decentralized version control, then please start at "How DVCS is
24
22
different." Otherwise, get some coffee or tea, get comfortable and get
27
The Purposes of Revision Control
28
================================
25
The purpose of version control
26
==============================
30
28
Odds are that you have worked on some sort of textual data -- the sources
31
29
to a program, web sites or the config files that Unix system
36
34
important information that you would desperately like to get back. If this
37
35
has ever happened to you, then you are probably ready for Bazaar.
39
Revision control systems (which I'll henceforth call RCS) such as
37
Version control systems (which I'll henceforth call VCS) such as
40
38
Bazaar give you the ability to track changes for a directory by turning
41
39
it into something slightly more complicated than a directory that we call
42
40
a **branch**. The branch not only stores how the directory looks right
44
42
do something you wish you hadn't, you can restore the directory to the way
45
43
it looked at some point in the past.
47
Revision control systems give users the ability to save changes to a
45
Version control systems give users the ability to save changes to a
48
46
branch by "committing a **revision**". The revision created is essentially
49
47
a summary of the changes that were made since the last time the tree was
52
50
These revisions have other uses as well. For example, one can comment
53
51
revisions to record what the recent set of changes meant by providing an
55
53
the web template to close the table" and "Added sftp suppport. Fixes #595"
57
55
We keep these logs so that if later there is some sort of problem with
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
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
65
63
server and "checkout" the code. Doing so gives one a directory in which a
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
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
70
The centralized model can have some drawbacks. A centralized RCS requires
68
The centralized model can have some drawbacks. A centralized VCS requires
71
69
that one is able to connect to the server whenever one wants to do version
72
70
control work. This can be a bit of a problem if your server is on some other
73
71
machine on the internet and you are not. Or, worse yet, you **are** on the
74
72
internet but the server is missing!
76
Decentralized Revision Control Systems (which I'll call DRCS after this
74
Decentralized Version Control Systems (which I'll call DVCS after this
77
75
point) deal with this problem by keeping branches on the same machine as
78
76
the client. In Bazaar's case, the branch is kept in the same place as
79
77
the code that is being version controlled. This allows the user to save
81
79
user only needs internet access when he wants to access the changes in
82
80
someone else's branch that are somewhere else.
85
83
A common requirement that many people have is the need to keep track of
86
84
the changes for a directory such as file and subdirectory changes.
87
85
Performing this tracking by hand is a awkward process that over time
88
86
becomes unwieldy. That is, until one considers version control tools such
89
87
as Bazaar. These tools automate the process of storing data by creating
90
a **revision** of the directory tree whenever the user asks.
88
a **revision** of the directory tree whenever the user asks.
92
Revision control software such as Bazaar can do much more than just
90
Version control software such as Bazaar can do much more than just
93
91
storage and performing undo. For example, with Bazaar a developer can
94
92
take the modifications in one branch of software and apply them to a
95
93
related branch -- even if those changes exist in a branch owned by
107
105
==============================
109
107
Bazaar installs a single new command, **bzr**. Everything else is a
110
subcommand of this. You can get some help with ``bzr help``. Some arguments
108
subcommand of this. You can get some help with ``bzr help``. Some arguments
111
109
are grouped in topics: ``bzr help topics`` to see which topics are available.
113
111
One function of a version control system is to keep track of who changed
117
115
address by looking up your username and hostname. If you don't like the
118
116
guess that Bazaar makes, then three options exist:
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.
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.
150
148
.. [1] On Windows, the users configuration files can be found in the
151
149
application data directory. So instead of ``~/.bazaar/branch.conf``
152
the configuration file can be found as:
150
the configuration file can be found as:
153
151
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
154
152
The same is true for ``locations.conf``, ``ignore``, and the
155
153
``plugins`` directory.
232
230
its test suite before committing, to make sure that every revision is a
233
231
known-good state. You can also review your changes, to make sure you're
234
232
committing what you intend to, and as a chance to rethink your work before
235
you permanently record it.
233
you permanently record it.
237
Two bzr commands are particularly useful here: **status** and **diff**.
235
Two bzr commands are particularly useful here: **status** and **diff**.
279
277
Some projects prefer patches to show a prefix at the start of the path
280
278
for old and new files. The ``--prefix`` option can be used to provide
282
As a shortcut, ``bzr diff -p1`` produces a form that works with the
280
As a shortcut, ``bzr diff -p1`` produces a form that works with the
283
281
command ``patch -p1``.
285
284
Committing changes
286
285
==================
288
287
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.
288
the branch, creating a new revision holding a snapshot of that state.
331
330
commit message when you have finished. If you would like parts to be
332
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
355
378
given then only those ones will be affected. ``bzr revert`` also clears the
356
379
list of pending merges revisions.
361
388
Many source trees contain some files that do not need to be versioned,
362
389
such as editor backups, object or bytecode files, and built programs. You
363
390
can simply not add them, but then they'll always crop up as unknown files.
400
427
% 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"
406
453
There are some ignored files which are not project specific, but more user
459
506
directory. This is a bit different to CVS, which requires that you also
460
507
do ``cvs remove``.
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.
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.
509
556
After this change, the local directory will be a mirror of the source. This
510
includes the ''revision-history'' - which is a list of the commits done in
557
includes the ''revision-history'' - which is a list of the commits done in
511
558
this branch, rather than merged from other branches.
513
560
This command only works if your local (destination) branch is either an
570
617
uses rsync to push the changes to the revision history and the working
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
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
579
626
============================
581
628
It happens to the best of us: sometimes you'll make changes in the wrong
added
removed
doc/en/tutorials/tutorial.txt
