14
Current for bzr-0.16, 2007-05
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
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.
112
There will be more in the future.
111
114
One function of a version control system is to keep track of who changed
112
115
what. In a decentralized system, that requires an identifier for each
113
116
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
117
email address. Bzr is smart enough to automatically generate an email
115
118
address by looking up your username and hostname. If you don't like the
116
119
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.
121
1. Set an email address via ``bzr whoami``. This is the simplest way.
123
To set a global identity, use::
125
% bzr whoami "Your Name <email@example.com>"
127
If you'd like to use a different address for a specific branch, enter
128
the branch folder and use::
130
% bzr whoami --branch "Your Name <email@example.com>"
132
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
133
adding the following lines. Please note that ``[DEFAULT]`` is case
137
email=Your Name <email@isp.com>
139
As above, you can override this settings on a branch by branch basis
140
by creating a branch section in ``~/.bazaar/locations.conf`` and
141
adding the following lines::
143
[/the/path/to/the/branch]
144
email=Your Name <email@isp.com>
147
#. Overriding the two previous options by setting the global environment
148
variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
149
precedence) to your full email address.
148
151
.. [1] On Windows, the users configuration files can be found in the
149
152
application data directory. So instead of ``~/.bazaar/branch.conf``
150
the configuration file can be found as:
153
the configuration file can be found as:
151
154
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
152
155
The same is true for ``locations.conf``, ``ignore``, and the
153
156
``plugins`` directory.
277
279
Some projects prefer patches to show a prefix at the start of the path
278
280
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
282
As a shortcut, ``bzr diff -p1`` produces a form that works with the
281
283
command ``patch -p1``.
284
285
Committing changes
285
286
==================
287
288
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.
289
the branch, creating a new revision holding a snapshot of that state.
316
317
override either of the above mentioned editor options. If you quit the
317
318
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
427
386
% 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
392
There are some ignored files which are not project specific, but more user
506
445
directory. This is a bit different to CVS, which requires that you also
507
446
do ``cvs remove``.
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.
448
``bzr remove`` makes the file un-versioned, but may or may not delete
449
the working copy [2]_. This is useful when you add the wrong file,
450
or decide that a file should actually not be versioned.
617
556
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
559
You can also use copy the files around manually, by sending a tarball, or
560
using rsync, or other related file transfer methods. This is usually
561
less safe than using ``push``, but may be faster or easier in some
564
Moving changes between trees
626
565
============================
628
567
It happens to the best of us: sometimes you'll make changes in the wrong
added
removed
doc/tutorial.txt
