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
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
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
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.
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.
113
113
One function of a version control system is to keep track of who changed
114
114
what. In a decentralized system, that requires an identifier for each
115
115
author that is globally unique. Most people already have one of these: an
116
email address. Bzr is smart enough to automatically generate an email
116
email address. Bazaar 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:
120
1. Setting the email address in the
121
``~/.bazaar/bazaar.conf`` by adding the following lines. Please note that
122
``[DEFAULT]`` is case sensitive::
125
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::
131
[/the/directory/to/the/branch]
132
email=Your Name <email@isp.com>
134
1. Overriding the two previous options by setting the global environment
135
variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
136
to your full email address.
118
guess that Bazaar makes, then three options exist:
120
1. Set an email address via ``bzr whoami``. This is the simplest way.
122
To set a global identity, use::
124
% bzr whoami "Your Name <email@example.com>"
126
If you'd like to use a different address for a specific branch, enter
127
the branch folder and use::
129
% bzr whoami --branch "Your Name <email@example.com>"
131
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
132
adding the following lines. Please note that ``[DEFAULT]`` is case
136
email=Your Name <email@isp.com>
138
As above, you can override this settings on a branch by branch basis
139
by creating a branch section in ``~/.bazaar/locations.conf`` and
140
adding the following lines::
142
[/the/path/to/the/branch]
143
email=Your Name <email@isp.com>
146
#. Overriding the two previous options by setting the global environment
147
variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
148
precedence) to your full email address.
150
.. [1] On Windows, the users configuration files can be found in the
151
application data directory. So instead of ``~/.bazaar/branch.conf``
152
the configuration file can be found as:
153
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
154
The same is true for ``locations.conf``, ``ignore``, and the
155
``plugins`` directory.
138
157
Creating a branch
139
158
=================
141
History is by default stored in the .bzr directory of the branch. There
142
will be a facility to store it in a separate repository, which may be
143
remote. We create a new branch by running **bzr init** in an existing
160
History is by default stored in the .bzr directory of the branch. In a
161
future version of Bazaar, there will be a facility to store it in a
162
separate repository, which may be remote.
164
We create a new branch by running ``bzr init`` in an existing directory::
179
205
All history is stored in a branch, which is just an on-disk directory
180
206
containing control files. By default there is no separate repository or
181
207
database as used in svn or svk. You can choose to create a repository if
182
you want to (see the **bzr init-repo** command). You may wish to do this
183
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
186
212
You'll usually refer to branches on your computer's filesystem just by
187
213
giving the name of the directory containing the branch. bzr also supports
188
accessing branches over http, for example::
190
% bzr log http://bazaar-ng.org/bzr/bzr.dev/
192
By installing bzr plugins you can also access branches over the sftp or
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.
195
225
Reviewing changes
196
226
=================
228
258
''patch'', ''diffstat'', ''filterdiff'' and ''colordiff''::
231
*** 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
238
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
239
269
the differences between two versions are shown::
241
271
% bzr diff -r 1000.. # everything since r1000
242
272
% bzr diff -r 1000..1100 # changes from 1000 to 1100
244
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,
245
275
passing options. For example::
247
277
% bzr diff --diff-options --side-by-side foo
249
Some projects prefer patches to show a prefix at the start of the path for
250
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
251
282
As a shortcut, ``bzr diff -p1`` produces a form that works with the
252
283
command ``patch -p1``.
279
310
Message from an editor
280
311
======================
282
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
283
314
editor for you to enter a message. The editor to run is controlled by
284
your `$EDITOR` environment variable or
285
add `editor` to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will override
286
the above mentioned editor options. If you quit the editor without
287
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.
320
The file that is opened in the editor contains a horizontal line. The part
321
of the file below this line is included for information only, and will not
322
form part of the commit message. Below the separator is shown the list of
323
files that are changed in the commit. You should write your message above
324
the line, and then save the file and exit.
326
If you would like to see the diff that will be committed as you edit the
327
message you can use the ``--show-diff`` option to ``commit``. This will include
328
the diff in the editor when it is opened, below the separator and the
329
information about the files that will be committed. This means that you can
330
read it as you write the message, but the diff itself wont be seen in the
331
commit message when you have finished. If you would like parts to be
332
included in the message you can copy and paste them above the separator.
348
393
they only determine whether unversioned files are reported as unknown or
351
The ''.bzrignore'' file should normally be versioned, so that new copies
396
The ``.bzrignore`` file should normally be versioned, so that new copies
352
397
of the branch see the same patterns::
354
399
% bzr add .bzrignore
355
400
% bzr commit -m "Add ignore patterns"
406
There are some ignored files which are not project specific, but more user
407
specific. Things like editor temporary files, or personal temporary files.
408
Rather than add these ignores to every project, bzr supports a global
409
ignore file in ``~/.bazaar/ignore`` [1]_. It has the same syntax as the
410
per-project ignore file.
358
413
Examining history
359
414
=================
364
The **bzr log** command shows a list of previous revisions. The **bzr log
365
--forward** command does the same in chronological order to get most
419
The ``bzr log`` command shows a list of previous revisions. The ``bzr log
420
--forward`` command does the same in chronological order to get most
366
421
recent revisions printed at last.
368
As with bzr diff, bzr log supports the -r argument::
423
As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
370
425
% bzr log -r 1000.. # Revision 1000 and everything after it
371
426
% bzr log -r ..1000 # Everything up to and including r1000
429
486
Often rather than starting your own project, you will want to submit a
430
change to an existing project. You can get a copy of an existing branch
431
by copying its directory, expanding a tarball, or by a remote copy using
432
something like rsync. You can also use bzr to fetch a copy. Because this
433
new copy is potentially a new branch, the command is called *branch*::
487
change to an existing project. To do this, you'll need to get a copy of
488
the existing branch. Because this new copy is potentially a new branch,
489
the command is called **branch**::
435
% bzr branch http://bazaar-ng.org/bzr/bzr.dev
491
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
438
494
This copies down the complete history of this branch, so we can do all
439
495
operations on it locally: log, annotate, making and merging branches.
440
496
There will be an option to get only part of the history if you wish.
498
You can also get a copy of an existing branch by copying its directory,
499
expanding a tarball, or by a remote copy using something like rsync.
442
501
Following upstream changes
443
502
==========================
472
If there is a conflict during a merge, 3 files with the same basename are
473
created. The filename of the common base is appended with .BASE, the
474
filename of the file containing your changes is appended .THIS and the
475
filename with the changes from the other tree is appended .OTHER.
476
Using a program such as kdiff3, you can now comfortably merge them into
477
one file. To commit you have to rename it to the original basename and
478
delete the other two files. As long as there exist files with .BASE, .THIS
479
or .OTHER the commit command will complain.
531
If there is a conflict during a merge, 3 files with the same basename
532
are created. The filename of the common base is appended with ".BASE",
533
the filename of the file containing your changes is appended with
534
".THIS" and the filename with the changes from the other tree is
535
appended with ".OTHER". Using a program such as kdiff3, you can now
536
comfortably merge them into one file. In order to commit you have to
537
rename the merged file (".THIS") to the original file name. To
538
complete the conflict resolution you must use the resolve command,
539
which will remove the ".OTHER" and ".BASE" files. As long as there
540
exist files with .BASE, .THIS or .OTHER the commit command will
545
% kdiff3 file.BASE file.OTHER file.THIS
481
549
[**TODO**: explain conflict markers within files]
489
557
directory. One can push a branch (or the changes for a branch) by one of
490
558
the following three methods:
492
* Rsync: rsync -avrz LOCALBRANCH servername.com/this/directory/here
494
(or any other tool for publishing a directory to a web site.)
496
* bzr push sftp://servername.com/this/directory/here
498
(The directory that must already exist)
500
* The push plugin that comes with BzrTools
560
* The best method is to use bzr itself to do it.
564
% bzr push sftp://servername.com/path/to/directory
566
(The destination directory must already exist unless the
567
``--create-prefix`` option is used.)
569
* Another option is the ``rspush`` plugin that comes with BzrTools, which
570
uses rsync to push the changes to the revision history and the working
573
You can also use copy the files around manually, by sending a tarball, or
574
using rsync, or other related file transfer methods. This is usually
575
less safe than using ``push``, but may be faster or easier in some
578
Moving changes between trees
579
============================
581
It happens to the best of us: sometimes you'll make changes in the wrong
582
tree. Maybe because you've accidentally started work in the wrong directory,
583
maybe because as you're working, the change turns out to be bigger than you
584
expected, so you start a new branch for it.
586
To move your changes from one tree to another, use
591
% bzr merge --uncommitted OLDDIR
593
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
594
It will not apply committed changes, even if they could be applied to NEWDIR
595
with a regular merge. The changes will remain in OLDDIR, but you can use ``bzr
596
revert OLDDIR`` to remove them, once you're satisfied with NEWDIR.
598
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
599
The more different they are, the greater the chance of conflicts.
added
removed
doc/en/tutorials/tutorial.txt
