20
20
If you are already familiar with decentralized revision control, then
21
please feel free to skip ahead to "Introducing Yourself to Bazaar-NG". If,
21
please feel free to skip ahead to "Introducing Yourself to Bazaar". If,
22
22
on the other hand, you are familiar with revision control but not
23
23
decentralized revision control, then please start at "How DRCS is
24
24
different." Otherwise, get some coffee or tea, get comfortable and get
34
34
deleted the configuration file for your mailserver or perhaps mauled the
35
35
source code for a pet project. Whatever happened, you have just deleted
36
36
important information that you would desperately like to get back. If this
37
has ever happened to you, then you are probably ready for Bazaar-NG.
37
has ever happened to you, then you are probably ready for Bazaar.
39
39
Revision control systems (which I'll henceforth call RCS) such as
40
Bazaar-NG give you the ability to track changes for a directory by turning
40
Bazaar give you the ability to track changes for a directory by turning
41
41
it into something slightly more complicated than a directory that we call
42
42
a **branch**. The branch not only stores how the directory looks right
43
43
now, but also how it looked at various points in the past. Then, when you
76
76
Decentralized Revision Control Systems (which I'll call DRCS after this
77
77
point) deal with this problem by keeping branches on the same machine as
78
the client. In Bazaar-NG's case, the branch is kept in the same place as
78
the client. In Bazaar's case, the branch is kept in the same place as
79
79
the code that is being version controlled. This allows the user to save
80
80
his changes (**commit**) whenever he wants -- even if he is offline. The
81
81
user only needs internet access when he wants to access the changes in
86
86
the changes for a directory such as file and subdirectory changes.
87
87
Performing this tracking by hand is a awkward process that over time
88
88
becomes unwieldy. That is, until one considers version control tools such
89
as Bazaar-NG. These tools automate the process of storing data by creating
89
as Bazaar. These tools automate the process of storing data by creating
90
90
a **revision** of the directory tree whenever the user asks.
92
Revision control software such as Bazaar-NG can do much more than just
93
storage and performing undo. For example, with Bazaar-NG developer can
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
94
take the modifications in one branch of software and apply them to
95
95
another, related, branch -- even if those changes exist in a branch owned
96
96
by somebody else. This allows developers to cooperate without giving write
97
97
access to repository.
99
Bazaar-NG remembers the ''ancestry'' of a revision: the previous revisions
99
Bazaar remembers the ''ancestry'' of a revision: the previous revisions
100
100
that it is based upon. A single revision may have more than one direct
101
101
descendant, each with different changes, representing a divergence in the
102
evolution of the tree. By branching, Bazaar-NG allows multiple people to
102
evolution of the tree. By branching, Bazaar allows multiple people to
103
103
cooperate on the evolution of a project, without all needing to work in
104
104
strict lock-step. Branching can be useful even for a single developer.
106
Introducing yourself to Bazaar-NG
107
=================================
106
Introducing yourself to Bazaar
107
==============================
109
Bazaar-NG installs a single new command, **bzr**. Everything else is a
109
Bazaar installs a single new command, **bzr**. Everything else is a
110
110
subcommand of this. You can get some help with `bzr help`. There will be
111
111
more in the future.
115
115
author that is globally unique. Most people already have one of these: an
116
116
email address. Bzr is smart enough to automatically generate an email
117
117
address by looking up your username and hostname. If you don't like the
118
guess that Bazaar-NG makes, then three options exist:
118
guess that Bazaar makes, then three options exist:
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>'
120
130
1. Setting the email address in the
121
``~/.bazaar/bazaar.conf`` by adding the following lines. Please note that
131
``~/.bazaar/bazaar.conf`` [1]_ by adding the following lines. Please note that
122
132
``[DEFAULT]`` is case sensitive::
125
135
email= Your Name <email@isp.com>
127
1. Override the previous setting on a
128
branch by branch basis by creating a branch section in
129
``~/.bazaar/branches.conf`` by adding the following lines::
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
131
141
[/the/directory/to/the/branch]
132
142
email=Your Name <email@isp.com>
135
145
variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
136
146
to your full email address.
148
.. [1] On Windows, the users configuration files can be found in the
149
application data directory. So instead of ``~/.bazaar/branch.conf``
150
the configuration file can be found as:
151
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
152
The same is true for ``locations.conf``, ``ignore``, and the
153
``plugins`` directory.
138
155
Creating a branch
139
156
=================
187
204
giving the name of the directory containing the branch. bzr also supports
188
205
accessing branches over http, for example::
190
% bzr log http://bazaar-ng.org/bzr/bzr.dev/
207
% bzr log http://bazaar-vcs.org/bzr/bzr.dev/
192
209
By installing bzr plugins you can also access branches over the sftp or
247
264
% bzr diff --diff-options --side-by-side foo
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
269
command ``patch -p1``.
249
271
Committing changes
250
272
==================
343
365
they only determine whether unversioned files are reported as unknown or
346
The ''.bzrignore'' file should normally be versioned, so that new copies
368
The ``.bzrignore`` file should normally be versioned, so that new copies
347
369
of the branch see the same patterns::
349
371
% bzr add .bzrignore
350
372
% bzr commit -m "Add ignore patterns"
378
There are some ignored files which are not project specific, but more user
379
specific. Things like editor temporary files, or personal temporary files.
380
Rather than add these ignores to every project, bzr supports a global
381
ignore file in ``~/.bazaar/ignore`` [1]_. It has the same syntax as the
382
per-project ignore file.
353
385
Examining history
354
386
=================
427
461
something like rsync. You can also use bzr to fetch a copy. Because this
428
462
new copy is potentially a new branch, the command is called *branch*::
430
% bzr branch http://bazaar-ng.org/bzr/bzr.dev
464
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
433
467
This copies down the complete history of this branch, so we can do all