130
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>
132
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by adding the following lines.
133
Please note that ``[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
140
[/the/path/to/the/branch]
141
email=Your Name <email@isp.com>
147
144
#. 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.
145
variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
146
to your full email address.
151
148
.. [1] On Windows, the users configuration files can be found in the
152
149
application data directory. So instead of ``~/.bazaar/branch.conf``
186
185
% bzr add hello.txt
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``.
190
If you add the wrong file, simply use **bzr remove** to make it
191
unversioned again. This does not delete the working copy.
205
196
All history is stored in a branch, which is just an on-disk directory
206
197
containing control files. By default there is no separate repository or
207
198
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
199
you want to (see the **bzr init-repo** command). You may wish to do this
209
200
if you have very large branches, or many branches of a moderately sized
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.
237
By default **bzr status** hides "boring" files that are either unchanged
238
or ignored. To see them too, use the --all option. The status command
239
can optionally be given the name of some files or directories to check.
258
246
''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
249
*** added file 'hello.txt'
268
With the ``-r`` option, the tree is compared to an earlier revision, or
256
With the ''-r'' option, the tree is compared to an earlier revision, or
269
257
the differences between two versions are shown::
271
259
% bzr diff -r 1000.. # everything since r1000
272
260
% bzr diff -r 1000..1100 # changes from 1000 to 1100
274
The ``--diff-options`` option causes bzr to run the external diff program,
262
The --diff-options option causes bzr to run the external diff program,
275
263
passing options. For example::
277
265
% 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
267
Some projects prefer patches to show a prefix at the start of the path for
268
old and new files. The --prefix option can be used to provide such a prefix.
282
269
As a shortcut, ``bzr diff -p1`` produces a form that works with the
283
270
command ``patch -p1``.
294
281
The **commit** command takes a message describing the changes in the
295
282
revision. It also records your userid, the current time and timezone, and
296
283
the inventory and contents of the tree. The commit message is specified
297
by the ``-m`` or ``--message`` option. You can enter a multi-line commit
284
by the ''-m'' or ''--message'' option. You can enter a multi-line commit
298
285
message; in most shells you can enter this just by leaving the quotes open
299
286
at the end of the line.
303
290
% bzr commit -m "added my first file"
305
You can also use the ``-F`` option to take the message from a file. Some
292
You can also use the -F option to take the message from a file. Some
306
293
people like to make notes for a commit message while they work, then
307
294
review the diff to make sure they did what they said they did. (This file
308
295
can also be useful when you pick up your work after a break.)
310
297
Message from an editor
311
298
======================
313
If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
300
If you use neither the `-m` nor the `-F` option then bzr will open an
314
301
editor for you to enter a message. The editor to run is controlled by
315
your ``$VISUAL`` or ``$EDITOR`` environment variable, which can be overridden
316
by the ``editor`` setting in ``~/.bazaar/bazaar.conf``; ``$BZR_EDITOR`` will
302
your `$VISUAL` or `$EDITOR` environment variable, which can be overridden
303
by the `editor` setting in to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will
317
304
override either of the above mentioned editor options. If you quit the
318
305
editor without making any changes, the commit will be cancelled.
337
324
If you've made some changes and don't want to keep them, use the
338
325
**revert** command to go back to the previous head version. It's a good
339
idea to use ``bzr diff`` first to see what will be removed. By default the
326
idea to use **bzr diff** first to see what will be removed. By default the
340
327
revert command reverts the whole tree; if file or directory names are
341
given then only those ones will be affected. ``bzr revert`` also clears the
328
given then only those ones will be affected. **revert** also clears the
342
329
list of pending merges revisions.
348
335
such as editor backups, object or bytecode files, and built programs. You
349
336
can simply not add them, but then they'll always crop up as unknown files.
350
337
You can also tell bzr to ignore these files by adding them to a file
351
called ``.bzrignore`` at the top of the tree.
338
called ''.bzrignore'' at the top of the tree.
353
340
This file contains a list of file wildcards (or "globs"), one per line.
354
341
Typical contents are like this::
361
348
If a glob contains a slash, it is matched against the whole path from the
362
349
top of the tree; otherwise it is matched against only the filename. So
363
350
the previous example ignores files with extension ``.o`` in all
364
subdirectories, but this example ignores only ``config.h`` at the top level
351
subdirectories, but this example ignores only config.h at the top level
365
352
and HTML files in ``doc/``::
370
357
To get a list of which files are ignored and what pattern they matched,
371
use ``bzr ignored``::
358
use ''bzr ignored''::
374
361
config.h ./config.h
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
392
The **bzr log** command shows a list of previous revisions. The **bzr log
393
--forward** command does the same in chronological order to get most
407
394
recent revisions printed at last.
409
As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
396
As with bzr diff, bzr log supports the -r argument::
411
398
% bzr log -r 1000.. # Revision 1000 and everything after it
412
399
% bzr log -r ..1000 # Everything up to and including r1000
444
431
You can delete files or directories by just deleting them from the working
445
432
directory. This is a bit different to CVS, which requires that you also
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.
435
**bzr remove** makes the file un-versioned, but does not delete
436
the working copy. This is useful when you add the wrong file, or decide
437
that a file should actually not be versioned.
472
459
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**::
460
change to an existing project. You can get a copy of an existing branch
461
by copying its directory, expanding a tarball, or by a remote copy using
462
something like rsync. You can also use bzr to fetch a copy. Because this
463
new copy is potentially a new branch, the command is called *branch*::
477
465
% bzr branch http://bazaar-vcs.org/bzr/bzr.dev
481
469
operations on it locally: log, annotate, making and merging branches.
482
470
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
472
Following upstream changes
488
473
==========================
504
489
Merging from related branches
505
490
=============================
507
If two branches have diverged (both have unique changes) then ``bzr
508
merge`` is the appropriate command to use. Merge will automatically
492
If two branches have diverged (both have unique changes) then **bzr
493
merge** is the appropriate command to use. Merge will automatically
509
494
calculate the changes that exist in the branch you're merging from that
510
495
are not in your branch and attempt to apply them in your branch.
543
528
directory. One can push a branch (or the changes for a branch) by one of
544
529
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
531
* Rsync: rsync -avrz LOCALBRANCH servername.com/path/to/directory
533
(or any other tool for publishing a directory to a web site.)
535
* bzr push sftp://servername.com/path/to/directory
552
537
(The destination directory must already exist unless the
553
538
``--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
540
* The rspush plugin that comes with BzrTools
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
543
Moving changes between trees
565
544
============================
579
558
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
580
559
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.
560
with a regular merge. The changes will remain in OLDDIR, but you can use **bzr
561
revert OLDDIR** to remove them, once you're satisfied with NEWDIR.
584
563
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
585
564
The more different they are, the greater the chance of conflicts.
added
removed
doc/tutorial.txt
