70
70
The centralized model can have some drawbacks. A centralized RCS requires
71
71
that one is able to connect to the server whenever one wants to do version
72
control work. This can be a bit of a problem if your server is on some other
73
machine on the internet and you are not. Or, worse yet, you **are** on the
72
control work. This can be a bit of a problem if your server on some other
73
machine on the internet and you are not. Or, worse yet, you ''are'' on the
74
74
internet but the server is missing!
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's case, the branch is kept in the same place as
78
the client. In Bazaar-NG'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. These tools automate the process of storing data by creating
89
as Bazaar-NG. 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 can do much more than just
93
storage and performing undo. For example, with Bazaar a developer can
94
take the modifications in one branch of software and apply them to a
95
related branch -- even if those changes exist in a branch owned by
96
somebody else. This allows developers to cooperate without giving
97
write access to the repository.
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
94
take the modifications in one branch of software and apply them to
95
another, related, branch -- even if those changes exist in a branch owned
96
by somebody else. This allows developers to cooperate without giving write
99
Bazaar remembers the ''ancestry'' of a revision: the previous revisions
99
Bazaar-NG 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 allows multiple people to
102
evolution of the tree. By branching, Bazaar-NG 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
107
==============================
106
Introducing yourself to Bazaar-NG
107
=================================
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.
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
114
113
One function of a version control system is to keep track of who changed
115
114
what. In a decentralized system, that requires an identifier for each
116
115
author that is globally unique. Most people already have one of these: an
117
116
email address. Bzr is smart enough to automatically generate an email
118
117
address by looking up your username and hostname. If you don't like the
119
guess that Bazaar makes, then three options exist:
118
guess that Bazaar-NG makes, then three options exist:
121
120
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.
151
.. [1] On Windows, the users configuration files can be found in the
152
application data directory. So instead of ``~/.bazaar/branch.conf``
153
the configuration file can be found as:
154
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
155
The same is true for ``locations.conf``, ``ignore``, and the
156
``plugins`` directory.
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>'
130
1. Setting the email address in the
131
``~/.bazaar/bazaar.conf`` by adding the following lines. Please note that
132
``[DEFAULT]`` is case sensitive::
135
email= Your Name <email@isp.com>
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
141
[/the/directory/to/the/branch]
142
email=Your Name <email@isp.com>
144
1. Overriding the two previous options by setting the global environment
145
variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
146
to your full email address.
158
148
Creating a branch
159
149
=================
161
History is by default stored in the .bzr directory of the branch. In a
162
future version of Bazaar, there will be a facility to store it in a
163
separate repository, which may be remote. We create a new branch by
164
running ``bzr init`` in an existing directory::
151
History is by default stored in the .bzr directory of the branch. There
152
will be a facility to store it in a separate repository, which may be
153
remote. We create a new branch by running **bzr init** in an existing
205
189
All history is stored in a branch, which is just an on-disk directory
206
190
containing control files. By default there is no separate repository or
207
191
database as used in svn or svk. You can choose to create a repository if
208
you want to (see the ``bzr init-repo`` command). You may wish to do this
209
if you have very large branches, or many branches of a moderately sized
192
you want to (see the **bzr init-repo** command). You may wish to do this
193
if you have very large branches, or many branches of a moderate sized
212
196
You'll usually refer to branches on your computer's filesystem just by
213
197
giving the name of the directory containing the branch. bzr also supports
214
accessing branches over http and sftp, for example::
216
% bzr log http://bazaar-vcs.org/bzr/bzr.dev/
217
% bzr log sftp://bazaar-vcs.org/bzr/bzr.dev/
219
By installing bzr plugins you can also access branches using the rsync
222
See the `Publishing your branch`_ section for more about how to put your
223
branch at a given location.
198
accessing branches over http, for example::
200
% bzr log http://bazaar-ng.org/bzr/bzr.dev/
202
By installing bzr plugins you can also access branches over the sftp or
225
205
Reviewing changes
226
206
=================
258
238
''patch'', ''diffstat'', ''filterdiff'' and ''colordiff''::
261
=== added file 'hello.txt'
262
--- hello.txt 1970-01-01 00:00:00 +0000
263
+++ hello.txt 2005-10-18 14:23:29 +0000
241
*** added file 'hello.txt'
268
With the ``-r`` option, the tree is compared to an earlier revision, or
248
With the ''-r'' option, the tree is compared to an earlier revision, or
269
249
the differences between two versions are shown::
271
251
% bzr diff -r 1000.. # everything since r1000
272
252
% bzr diff -r 1000..1100 # changes from 1000 to 1100
274
The ``--diff-options`` option causes bzr to run the external diff program,
254
The --diff-options option causes bzr to run the external diff program,
275
255
passing options. For example::
277
257
% bzr diff --diff-options --side-by-side foo
279
Some projects prefer patches to show a prefix at the start of the path
280
for old and new files. The ``--prefix`` option can be used to provide
259
Some projects prefer patches to show a prefix at the start of the path for
260
old and new files. The --prefix option can be used to provide such a prefix.
282
261
As a shortcut, ``bzr diff -p1`` produces a form that works with the
283
262
command ``patch -p1``.
379
358
they only determine whether unversioned files are reported as unknown or
382
The ``.bzrignore`` file should normally be versioned, so that new copies
361
The ''.bzrignore'' file should normally be versioned, so that new copies
383
362
of the branch see the same patterns::
385
364
% bzr add .bzrignore
386
365
% bzr commit -m "Add ignore patterns"
392
There are some ignored files which are not project specific, but more user
393
specific. Things like editor temporary files, or personal temporary files.
394
Rather than add these ignores to every project, bzr supports a global
395
ignore file in ``~/.bazaar/ignore`` [1]_. It has the same syntax as the
396
per-project ignore file.
399
368
Examining history
400
369
=================
405
The ``bzr log`` command shows a list of previous revisions. The ``bzr log
406
--forward`` command does the same in chronological order to get most
374
The **bzr log** command shows a list of previous revisions. The **bzr log
375
--forward** command does the same in chronological order to get most
407
376
recent revisions printed at last.
409
As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
378
As with bzr diff, bzr log supports the -r argument::
411
380
% bzr log -r 1000.. # Revision 1000 and everything after it
412
381
% bzr log -r ..1000 # Everything up to and including r1000
472
441
Often rather than starting your own project, you will want to submit a
473
change to an existing project. To do this, you'll need to get a copy of
474
the existing branch. Because this new copy is potentially a new branch,
475
the command is called **branch**::
442
change to an existing project. You can get a copy of an existing branch
443
by copying its directory, expanding a tarball, or by a remote copy using
444
something like rsync. You can also use bzr to fetch a copy. Because this
445
new copy is potentially a new branch, the command is called *branch*::
477
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
447
% bzr branch http://bazaar-ng.org/bzr/bzr.dev
480
450
This copies down the complete history of this branch, so we can do all
481
451
operations on it locally: log, annotate, making and merging branches.
482
452
There will be an option to get only part of the history if you wish.
484
You can also get a copy of an existing branch by copying its directory,
485
expanding a tarball, or by a remote copy using something like rsync.
487
454
Following upstream changes
488
455
==========================
517
If there is a conflict during a merge, 3 files with the same basename
518
are created. The filename of the common base is appended with ".BASE",
519
the filename of the file containing your changes is appended with
520
".THIS" and the filename with the changes from the other tree is
521
appended with ".OTHER". Using a program such as kdiff3, you can now
522
comfortably merge them into one file. In order to commit you have to
523
rename the merged file (".THIS") to the original file name. To
524
complete the conflict resolution you must use the resolve command,
525
which will remove the ".OTHER" and ".BASE" files. As long as there
526
exist files with .BASE, .THIS or .OTHER the commit command will
531
% kdiff3 file.BASE file.OTHER file.THIS
484
If there is a conflict during a merge, 3 files with the same basename are
485
created. The filename of the common base is appended with .BASE, the
486
filename of the file containing your changes is appended .THIS and the
487
filename with the changes from the other tree is appended .OTHER.
488
Using a program such as kdiff3, you can now comfortably merge them into
489
one file. To commit you have to rename it to the original basename and
490
delete the other two files. As long as there exist files with .BASE, .THIS
491
or .OTHER the commit command will complain.
535
493
[**TODO**: explain conflict markers within files]
543
501
directory. One can push a branch (or the changes for a branch) by one of
544
502
the following three methods:
546
* The best method is to use bzr itself to do it.
550
% bzr push sftp://servername.com/path/to/directory
552
(The destination directory must already exist unless the
553
``--create-prefix`` option is used.)
555
* Another option is the ``rspush`` plugin that comes with BzrTools, which
556
uses rsync to push the changes to the revision history and the working
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
565
============================
567
It happens to the best of us: sometimes you'll make changes in the wrong
568
tree. Maybe because you've accidentally started work in the wrong directory,
569
maybe because as you're working, the change turns out to be bigger than you
570
expected, so you start a new branch for it.
572
To move your changes from one tree to another, use
577
% bzr merge --uncommitted OLDDIR
579
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
580
It will not apply committed changes, even if they could be applied to NEWDIR
581
with a regular merge. The changes will remain in OLDDIR, but you can use ``bzr
582
revert OLDDIR`` to remove them, once you're satisfied with NEWDIR.
584
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
585
The more different they are, the greater the chance of conflicts.
504
* Rsync: rsync -avrz LOCALBRANCH servername.com/this/directory/here
506
(or any other tool for publishing a directory to a web site.)
508
* bzr push sftp://servername.com/this/directory/here
510
(The directory that must already exist)
512
* The rspush plugin that comes with BzrTools
added
removed
doc/tutorial.txt
