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 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 is 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
90
90
a **revision** of the directory tree whenever the user asks.
92
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
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
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.
99
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
107
107
==============================
109
109
Bazaar 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
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
118
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
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`` [1]_ 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.
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``
155
158
Creating a branch
156
159
=================
158
History is by default stored in the .bzr directory of the branch. There
159
will be a facility to store it in a separate repository, which may be
160
remote. We create a new branch by running **bzr init** in an existing
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::
175
As for CVS, there are three classes of file: unknown, ignored, and
178
As with CVS, there are three classes of file: unknown, ignored, and
176
179
versioned. The **add** command makes a file versioned: that is, changes
177
180
to it will be recorded by the system::
185
186
% bzr add hello.txt
190
If you add the wrong file, simply use **bzr remove** to make it
191
unversioned again. This does not delete the working copy.
193
If you add the wrong file, simply use ``bzr remove`` to make it
194
unversioned again. This does not delete the working copy in this case,
195
though it may in others [2]_.
197
.. [2] ``bzr remove`` will remove the working copy if it is currently
198
versioned, but has no changes from the last committed version. You
199
can force the file to always be kept with the ``--keep`` option to
200
``bzr remove``, or force it to always be deleted with ``--force``.
196
205
All history is stored in a branch, which is just an on-disk directory
197
206
containing control files. By default there is no separate repository or
198
207
database as used in svn or svk. You can choose to create a repository if
199
you want to (see the **bzr init-repo** command). You may wish to do this
200
if you have very large branches, or many branches of a moderate sized
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
203
212
You'll usually refer to branches on your computer's filesystem just by
204
213
giving the name of the directory containing the branch. bzr also supports
205
accessing branches over http, for example::
214
accessing branches over http and sftp, for example::
207
216
% bzr log http://bazaar-vcs.org/bzr/bzr.dev/
209
By installing bzr plugins you can also access branches over the sftp or
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.
212
225
Reviewing changes
213
226
=================
236
By default **bzr status** hides "boring" files that are either unchanged
237
or ignored. To see them too, use the --all option. The status command
238
can optionally be given the name of some files or directories to check.
249
``bzr status`` hides "boring" files that are either unchanged or ignored.
250
The status command can optionally be given the name of some files or
251
directories to check.
245
258
''patch'', ''diffstat'', ''filterdiff'' and ''colordiff''::
248
*** added file 'hello.txt'
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
255
With the ''-r'' option, the tree is compared to an earlier revision, or
268
With the ``-r`` option, the tree is compared to an earlier revision, or
256
269
the differences between two versions are shown::
258
271
% bzr diff -r 1000.. # everything since r1000
259
272
% bzr diff -r 1000..1100 # changes from 1000 to 1100
261
The --diff-options option causes bzr to run the external diff program,
274
The ``--diff-options`` option causes bzr to run the external diff program,
262
275
passing options. For example::
264
277
% 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.
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
268
282
As a shortcut, ``bzr diff -p1`` produces a form that works with the
269
283
command ``patch -p1``.
280
294
The **commit** command takes a message describing the changes in the
281
295
revision. It also records your userid, the current time and timezone, and
282
296
the inventory and contents of the tree. The commit message is specified
283
by the ''-m'' or ''--message'' option. You can enter a multi-line commit
297
by the ``-m`` or ``--message`` option. You can enter a multi-line commit
284
298
message; in most shells you can enter this just by leaving the quotes open
285
299
at the end of the line.
289
303
% bzr commit -m "added my first file"
291
You can also use the -F option to take the message from a file. Some
305
You can also use the ``-F`` option to take the message from a file. Some
292
306
people like to make notes for a commit message while they work, then
293
307
review the diff to make sure they did what they said they did. (This file
294
308
can also be useful when you pick up your work after a break.)
296
310
Message from an editor
297
311
======================
299
If you use neither the `-m` nor the `-F` option then bzr will open an
313
If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
300
314
editor for you to enter a message. The editor to run is controlled by
301
your `$EDITOR` environment variable or
302
add `editor` to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will override
303
the above mentioned editor options. If you quit the editor without
304
making any changes, the commit will be cancelled.
315
your ``$VISUAL`` or ``$EDITOR`` environment variable, which can be overridden
316
by the ``editor`` setting in ``~/.bazaar/bazaar.conf``; ``$BZR_EDITOR`` will
317
override either of the above mentioned editor options. If you quit the
318
editor without making any changes, the commit will be cancelled.
323
337
If you've made some changes and don't want to keep them, use the
324
338
**revert** command to go back to the previous head version. It's a good
325
idea to use **bzr diff** first to see what will be removed. By default the
339
idea to use ``bzr diff`` first to see what will be removed. By default the
326
340
revert command reverts the whole tree; if file or directory names are
327
given then only those ones will be affected. **revert** also clears the
341
given then only those ones will be affected. ``bzr revert`` also clears the
328
342
list of pending merges revisions.
334
348
such as editor backups, object or bytecode files, and built programs. You
335
349
can simply not add them, but then they'll always crop up as unknown files.
336
350
You can also tell bzr to ignore these files by adding them to a file
337
called ''.bzrignore'' at the top of the tree.
351
called ``.bzrignore`` at the top of the tree.
339
353
This file contains a list of file wildcards (or "globs"), one per line.
340
354
Typical contents are like this::
347
361
If a glob contains a slash, it is matched against the whole path from the
348
362
top of the tree; otherwise it is matched against only the filename. So
349
363
the previous example ignores files with extension ``.o`` in all
350
subdirectories, but this example ignores only config.h at the top level
364
subdirectories, but this example ignores only ``config.h`` at the top level
351
365
and HTML files in ``doc/``::
356
370
To get a list of which files are ignored and what pattern they matched,
357
use ''bzr ignored''::
371
use ``bzr ignored``::
360
374
config.h ./config.h
391
The **bzr log** command shows a list of previous revisions. The **bzr log
392
--forward** command does the same in chronological order to get most
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
393
407
recent revisions printed at last.
395
As with bzr diff, bzr log supports the -r argument::
409
As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
397
411
% bzr log -r 1000.. # Revision 1000 and everything after it
398
412
% bzr log -r ..1000 # Everything up to and including r1000
430
444
You can delete files or directories by just deleting them from the working
431
445
directory. This is a bit different to CVS, which requires that you also
434
**bzr remove** makes the file un-versioned, but does not delete
435
the working copy. This is useful when you add the wrong file, or decide
436
that 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.
458
472
Often rather than starting your own project, you will want to submit a
459
change to an existing project. You can get a copy of an existing branch
460
by copying its directory, expanding a tarball, or by a remote copy using
461
something like rsync. You can also use bzr to fetch a copy. Because this
462
new copy is potentially a new branch, the command is called *branch*::
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**::
464
477
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
468
481
operations on it locally: log, annotate, making and merging branches.
469
482
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.
471
487
Following upstream changes
472
488
==========================
488
504
Merging from related branches
489
505
=============================
491
If two branches have diverged (both have unique changes) then **bzr
492
merge** is the appropriate command to use. Merge will automatically
507
If two branches have diverged (both have unique changes) then ``bzr
508
merge`` is the appropriate command to use. Merge will automatically
493
509
calculate the changes that exist in the branch you're merging from that
494
510
are not in your branch and attempt to apply them in your branch.
501
If there is a conflict during a merge, 3 files with the same basename are
502
created. The filename of the common base is appended with .BASE, the
503
filename of the file containing your changes is appended .THIS and the
504
filename with the changes from the other tree is appended .OTHER.
505
Using a program such as kdiff3, you can now comfortably merge them into
506
one file. To commit you have to rename it to the original basename and
507
delete the other two files. As long as there exist files with .BASE, .THIS
508
or .OTHER the commit command will complain.
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
510
535
[**TODO**: explain conflict markers within files]
518
543
directory. One can push a branch (or the changes for a branch) by one of
519
544
the following three methods:
521
* Rsync: rsync -avrz LOCALBRANCH servername.com/this/directory/here
523
(or any other tool for publishing a directory to a web site.)
525
* bzr push sftp://servername.com/this/directory/here
527
(The directory that must already exist)
529
* The rspush plugin that comes with BzrTools
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.
added
removed
doc/en/user-guide/tutorial.txt
