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
110
subcommand of this. You can get some help with `bzr help`. There will be
109
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
111
are grouped in topics: ``bzr help topics`` to see which topics are available.
112
There will be more in the future.
113
114
One function of a version control system is to keep track of who changed
114
115
what. In a decentralized system, that requires an identifier for each
115
116
author that is globally unique. Most people already have one of these: an
116
117
email address. Bzr is smart enough to automatically generate an email
117
118
address by looking up your username and hostname. If you don't like the
118
guess that Bazaar-NG makes, then three options exist:
119
guess that Bazaar makes, then three options exist:
120
121
1. Set an email address via ``bzr whoami``. This is the simplest way.
121
122
To set a global identity, use::
145
146
variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
146
147
to your full email address.
149
.. [1] On Windows, the users configuration files can be found in the
150
application data directory. So instead of ``~/.bazaar/branch.conf``
151
the configuration file can be found as:
152
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
153
The same is true for ``locations.conf``, ``ignore``, and the
154
``plugins`` directory.
148
156
Creating a branch
149
157
=================
292
300
If you use neither the `-m` nor the `-F` option then bzr will open an
293
301
editor for you to enter a message. The editor to run is controlled by
294
your `$EDITOR` environment variable or
295
add `editor` to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will override
296
the above mentioned editor options. If you quit the editor without
297
making any changes, the commit will be cancelled.
302
your `$VISUAL` or `$EDITOR` environment variable, which can be overridden
303
by the `editor` setting in to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will
304
override either of the above mentioned editor options. If you quit the
305
editor without making any changes, the commit will be cancelled.
358
366
they only determine whether unversioned files are reported as unknown or
361
The ''.bzrignore'' file should normally be versioned, so that new copies
369
The ``.bzrignore`` file should normally be versioned, so that new copies
362
370
of the branch see the same patterns::
364
372
% bzr add .bzrignore
365
373
% bzr commit -m "Add ignore patterns"
379
There are some ignored files which are not project specific, but more user
380
specific. Things like editor temporary files, or personal temporary files.
381
Rather than add these ignores to every project, bzr supports a global
382
ignore file in ``~/.bazaar/ignore`` [1]_. It has the same syntax as the
383
per-project ignore file.
368
386
Examining history
369
387
=================
512
530
* The rspush plugin that comes with BzrTools
533
Moving changes between trees
534
============================
536
It happens to the best of us: sometimes you'll make changes in the wrong
537
tree. Maybe because you've accidentally started work in the wrong directory,
538
maybe because as you're working, the change turns out to be bigger than you
539
expected, so you start a new branch for it.
541
To move your changes from one tree to another, use
546
% bzr merge --uncommitted OLDDIR
548
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
549
It will not apply committed changes, even if they could be applied to NEWDIR
550
with a regular merge. The changes will remain in OLDDIR, but you can use **bzr
551
revert OLDDIR** to remove them, once you're satisfied with NEWDIR.
553
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
554
The more different they are, the greater the chance of conflicts.
added
removed
doc/tutorial.txt
