~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tutorial.txt

- stub for revision properties

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. This file is in Python ReStructuredText format - it can be formatted
2
 
.. into HTML or text.  In the future we plan to extract the example commands
3
 
.. and automatically test them.
4
 
 
5
 
.. This text was previously on the wiki at
6
 
.. http://bazaar.canonical.com/IntroductionToBzr
7
 
.. but has been moved into the source tree so it can be kept in sync with
8
 
.. the source and possibly automatically checked.
9
 
 
10
 
===============
11
 
Bazaar Tutorial
12
 
===============
 
1
==================
 
2
Bazaar-NG Tutorial
 
3
==================
 
4
 
 
5
current for bzr 0.0.6pre, July 2005
 
6
 
 
7
 
 
8
*NOTE* For a more current and user-editable version of this 
 
9
document, see the wiki at http://bazaar.canonical.com/IntroductionToBzr
13
10
 
14
11
 
15
12
Introduction
16
13
============
17
14
 
18
 
If you are already familiar with decentralized version control, then
19
 
please feel free to skip ahead to "Introducing Yourself to Bazaar". If,
20
 
on the other hand, you are familiar with version control but not
21
 
decentralized version control, then please start at "How DVCS is
22
 
different." Otherwise, get some coffee or tea, get comfortable and get
23
 
ready to catch up.
24
 
 
25
 
The purpose of version control
26
 
==============================
27
 
 
28
 
Odds are that you have worked on some sort of textual data -- the sources
29
 
to a program, web sites or the config files that Unix system
30
 
administrators have to deal with in /etc. The chances are also good that
31
 
you have made some sort of mistake that you deeply regretted. Perhaps you
32
 
deleted the configuration file for your mailserver or perhaps mauled the
33
 
source code for a pet project. Whatever happened, you have just deleted
34
 
important information that you would desperately like to get back. If this
35
 
has ever happened to you, then you are probably ready for Bazaar.
36
 
 
37
 
Version control systems (which I'll henceforth call VCS) such as
38
 
Bazaar give you the ability to track changes for a directory by turning
39
 
it into something slightly more complicated than a directory that we call
40
 
a **branch**. The branch not only stores how the directory looks right
41
 
now, but also how it looked at various points in the past. Then, when you
42
 
do something you wish you hadn't, you can restore the directory to the way
43
 
it looked at some point in the past.
44
 
 
45
 
Version control systems give users the ability to save changes to a
46
 
branch by "committing a **revision**". The revision created is essentially
47
 
a summary of the changes that were made since the last time the tree was
48
 
saved.
49
 
 
50
 
These revisions have other uses as well. For example, one can comment
51
 
revisions to record what the recent set of changes meant by providing an
52
 
optional log message. Real life log messages include things like "Fixed
53
 
the web template to close the table" and "Added SFTP suppport. Fixes #595"
54
 
        
55
 
We keep these logs so that if later there is some sort of problem with
56
 
SFTP, we can figure out when the problem probably happened.
57
 
 
58
 
How DVCS is different
59
 
=====================
60
 
 
61
 
Many Version Control Systems (VCS) are stored on servers. If one wants to
62
 
work on the code stored within a VCS, then one needs to connect to the
63
 
server and "checkout" the code. Doing so gives one a directory in which a
64
 
person can make changes and then commit. The VCS client then connects to
65
 
the VCS server and stores the changes. This method is known as the
66
 
centralized model.
67
 
 
68
 
The centralized model can have some drawbacks. A centralized VCS requires
69
 
that one is able to connect to the server whenever one wants to do version
70
 
control work. This can be a bit of a problem if your server is on some other
71
 
machine on the internet and you are not. Or, worse yet, you **are** on the
72
 
internet but the server is missing!
73
 
 
74
 
Decentralized Version Control Systems (which I'll call DVCS after this
75
 
point) deal with this problem by keeping branches on the same machine as
76
 
the client. In Bazaar's case, the branch is kept in the same place as
77
 
the code that is being version controlled. This allows the user to save
78
 
his changes (**commit**) whenever he wants -- even if he is offline. The
79
 
user only needs internet access when he wants to access the changes in
80
 
someone else's branch that are somewhere else.
81
 
 
82
 
 
83
 
A common requirement that many people have is the need to keep track of
84
 
the changes for a directory such as file and subdirectory changes.
85
 
Performing this tracking by hand is a awkward process that over time
86
 
becomes unwieldy. That is, until one considers version control tools such
87
 
as Bazaar. These tools automate the process of storing data by creating
88
 
a **revision** of the directory tree whenever the user asks.
89
 
 
90
 
Version control software such as Bazaar can do much more than just
91
 
storage and performing undo.  For example, with Bazaar a developer can
92
 
take the modifications in one branch of software and apply them to a
93
 
related branch -- even if those changes exist in a branch owned by
94
 
somebody else. This allows developers to cooperate without giving
95
 
write access to the repository.
96
 
 
97
 
Bazaar remembers the ''ancestry'' of a revision: the previous revisions
98
 
that it is based upon.  A single revision may have more than one direct
99
 
descendant, each with different changes, representing a divergence in the
100
 
evolution of the tree. By branching, Bazaar allows multiple people to
101
 
cooperate on the evolution of a project, without all needing to work in
102
 
strict lock-step.  Branching can be useful even for a single developer.
103
 
 
104
 
Introducing yourself to Bazaar
105
 
==============================
106
 
 
107
 
Bazaar installs a single new command, **bzr**.  Everything else is a
108
 
subcommand of this.  You can get some help with ``bzr help``. Some arguments
109
 
are grouped in topics: ``bzr help topics`` to see which topics are available.
110
 
 
111
 
One function of a version control system is to keep track of who changed
112
 
what.  In a decentralized system, that requires an identifier for each
113
 
author that is globally unique.  Most people already have one of these: an
114
 
email address. Bazaar is smart enough to automatically generate an email
115
 
address by looking up your username and hostname. If you don't like the
116
 
guess that Bazaar makes, then three options exist:
117
 
 
118
 
1. Set an email address via ``bzr whoami``.  This is the simplest way.
119
 
 
120
 
   To set a global identity, use::
121
 
 
122
 
   % bzr whoami "Your Name <email@example.com>"
123
 
 
124
 
   If you'd like to use a different address for a specific branch, enter
125
 
   the branch folder and use::
126
 
 
127
 
   % bzr whoami --branch "Your Name <email@example.com>"
128
 
 
129
 
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
130
 
   adding the following lines.  Please note that  ``[DEFAULT]`` is case
131
 
   sensitive::
132
 
 
133
 
       [DEFAULT]
134
 
       email=Your Name <email@isp.com>
135
 
 
136
 
   As above, you can override this settings on a branch by branch basis
137
 
   by creating a branch section in ``~/.bazaar/locations.conf`` and
138
 
   adding the following lines::
139
 
 
140
 
       [/the/path/to/the/branch]
141
 
       email=Your Name <email@isp.com>
142
 
 
143
 
 
144
 
#. Overriding the two previous options by setting the global environment
145
 
   variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
146
 
   precedence) to your full email address.
147
 
 
148
 
.. [1] On Windows, the users configuration files can be found in the
149
 
   application data directory. So instead of ``~/.bazaar/branch.conf``
150
 
   the configuration file can be found as:
151
 
   ``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
152
 
   The same is true for ``locations.conf``, ``ignore``, and the
153
 
   ``plugins`` directory.
 
15
Bazaar-NG is a version control tool.  It manages trees of files and subdirectories.  In particular, it records *revisions* of trees, representing their state at a particular point in time, and information about those revisions and their relationships.  Recording and retrieving tree revisions is useful in several ways if you are writing software or documents or doing similar creative work.
 
16
 
 
17
 * Keeping previous revisions lets you go back if you make a mistake or want to check your work.  It acts as a high-level unlimited undo.
 
18
 
 
19
 * By recording comments on every revision, you produce an annotated history of the project, describing what, who, why, and when.
 
20
 
 
21
 * Using a version control tool can be an aid to thinking about a project: getting to a stable state at regular intervals and then writing a description of what you did is an easy way to stay organized and on track.
 
22
 
 
23
Bazaar-NG remembers the *ancestry* of a revision: the previous revisions that it is based upon.  A single revision may have more than one direct descendant, each with different changes, representing a divergence in the evolution of the tree.  
 
24
By branching, Bazaar-NG allows multiple people to cooperate on the evolution of a project, without all needing to work in strict
 
25
lock-step.  Branching can be useful even for a single developer.
 
26
 
 
27
Bazaar-NG installs a single new command,
 
28
*bzr*.  Everything else is a subcommand of this.  You can get
 
29
some help with ``bzr help``.  There will be more in the future.
 
30
 
 
31
 
 
32
 
 
33
Introducing yourself to bzr
 
34
===========================
 
35
 
 
36
One function of a version control system is to keep track of who
 
37
changed what.  In a distributed system that requires an identifier for
 
38
each author that is globally unique.  Most people already have one of
 
39
these: an email address.
 
40
 
 
41
[after 0.0.4] To tell bzr which email address to use, put it in the file
 
42
``$HOME/.bzr.conf/email``, or the environment variable ``$BZREMAIL``.
 
43
If neither of these are set, bzr will use the ``$EMAIL``
 
44
variable, or use your username and hostname.
 
45
 
 
46
To check this has taken effect, or if you forget your own name, use
 
47
the ``whoami`` ("who am i?") command::
 
48
 
 
49
  % bzr whoami
 
50
 
 
51
Some people want to avoid sharing their email address so as not to
 
52
get spam.  bzr will never
 
53
disclose your email address unless you tell it to by publishing an
 
54
archive or transmitting a changeset.  It's recommended that you do use
 
55
a real address, so that people can contact you about your work, but
 
56
it's not required.  You can use an address which is obfuscated, which
 
57
bounces, or which goes through an anti-spam service such as spamgourmet.com.
 
58
 
 
59
 
154
60
 
155
61
Creating a branch
156
 
=================
157
 
 
158
 
History is by default stored in the .bzr directory of the branch. In a
159
 
future version of Bazaar, there will be a facility to store it in a
160
 
separate repository, which may be remote.
161
 
 
162
 
We create a new branch by running ``bzr init`` in an existing directory::
 
62
==================
 
63
 
 
64
 
 
65
History is by default stored in the .bzr directory of the branch.
 
66
There will be a facility to store it in a separate repository, which
 
67
may be remote.  We create a new branch by running *bzr init* in
 
68
an existing directory::
163
69
 
164
70
    % mkdir tutorial
165
71
    % cd tutorial
166
72
    % ls -a
 
73
    ls -a
167
74
    ./  ../
168
75
    % pwd
169
76
    /home/mbp/work/bzr.test/tutorial
173
80
    ./  ../  .bzr/
174
81
    %
175
82
 
176
 
As with CVS, there are three classes of file: unknown, ignored, and
177
 
versioned.  The **add** command makes a file versioned: that is, changes
178
 
to it will be recorded by the system::
 
83
As for CVS, there are three classes of file: unknown, ignored, and
 
84
versioned.  The *add* command makes a file versioned: that is,
 
85
changes to it will be recorded by the system::
179
86
 
180
87
    % echo 'hello world' > hello.txt
181
88
    % bzr status
182
 
    unknown:
183
 
      hello.txt
184
 
    % bzr add hello.txt
185
 
    added hello.txt
186
 
    % bzr status
187
 
    added:
188
 
      hello.txt
189
 
 
190
 
 
191
 
If you add the wrong file, simply use ``bzr remove`` to make it
192
 
unversioned again.  This does not delete the working copy in this case,
193
 
though it may in others [2]_.
194
 
 
195
 
.. [2] ``bzr remove`` will remove the working copy if it is currently
196
 
   versioned, but has no changes from the last committed version.  You
197
 
   can force the file to always be kept with the ``--keep`` option to
198
 
   ``bzr remove``, or force it to always be deleted with ``--force``.
199
 
 
200
 
Branch locations
201
 
================
202
 
 
203
 
All history is stored in a branch, which is just an on-disk directory
204
 
containing control files.  By default there is no separate repository or
205
 
database as used in svn or svk. You can choose to create a repository if
206
 
you want to (see the ``bzr init-repo`` command). You may wish to do this
207
 
if you have very large branches, or many branches of a moderately sized
208
 
project.
209
 
 
210
 
You'll usually refer to branches on your computer's filesystem just by
211
 
giving the name of the directory containing the branch.  bzr also supports
212
 
accessing branches over SSH, HTTP and SFTP, amongst other things::
213
 
 
214
 
    % bzr log bzr+ssh://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/
215
 
    % bzr log http://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/
216
 
    % bzr log sftp://bazaar.launchpad.net/~bzr-pqm/bzr/bzr.dev/
217
 
 
218
 
By installing bzr plugins you can also access branches using the rsync
219
 
protocol.
220
 
 
221
 
See the `Publishing your branch`_ section for more about how to put your
222
 
branch at a given location.
 
89
    ?       hello.txt
 
90
    % bzr unknowns
 
91
    hello.txt
 
92
    % bzr add -v hello.txt
 
93
    A       hello.txt
 
94
    % bzr unknowns
 
95
 
 
96
 
 
97
If you add the wrong file, simply use ``bzr remove`` to make
 
98
it unversioned again.  This does not delete the working copy.
 
99
 
223
100
 
224
101
Reviewing changes
225
102
=================
226
103
 
227
 
Once you have completed some work, you will want to **commit** it to the
228
 
version history.  It is good to commit fairly often: whenever you get a
229
 
new feature working, fix a bug, or improve some code or documentation.
230
 
It's also a good practice to make sure that the code compiles and passes
231
 
its test suite before committing, to make sure that every revision is a
232
 
known-good state.  You can also review your changes, to make sure you're
233
 
committing what you intend to, and as a chance to rethink your work before
234
 
you permanently record it.
235
 
 
236
 
Two bzr commands are particularly useful here: **status** and **diff**.
237
 
 
238
 
bzr status
239
 
----------
240
 
 
241
 
The **status** command tells you what changes have been made to the
242
 
working directory since the last revision::
 
104
Once you have completed some work, you will want to *commit*
 
105
it to the version history.  It is good to commit fairly often:
 
106
whenever you get a new feature working, fix a bug, or improve some
 
107
code or documentation.  It's also a good practice to make sure that
 
108
the code compiles and passes its test suite before committing, to make
 
109
sure that every revision is a known-good state.  You can also review
 
110
your changes, to make sure you're committing what you intend to, and
 
111
as a chance to rethink your work before you permanently record it. 
 
112
 
 
113
Two bzr commands are particularly useful here: *status* and
 
114
*diff*.  The *status* command
 
115
shows a listing with one line per file, indicating whether it has been
 
116
Added, Deleted, Modified, or Renamed in the current revision.  Unknown
 
117
files are shown as '?'.  With the ``--all`` option, the status
 
118
command also shows unmodified versioned files as '.', and ignored
 
119
files as 'I'::
243
120
 
244
121
    % bzr status
245
 
    modified:
246
 
       foo
247
 
 
248
 
``bzr status`` hides "boring" files that are either unchanged or ignored.
249
 
The status command can optionally be given the name of some files or
250
 
directories to check.
251
 
 
252
 
bzr diff
253
 
--------
254
 
 
255
 
The **diff** command shows the full text of changes to all files as a
256
 
standard unified diff.  This can be piped through many programs such as
257
 
''patch'', ''diffstat'', ''filterdiff'' and ''colordiff''::
 
122
    A       hello.txt
 
123
 
 
124
The *diff* command shows the full text of changes to all
 
125
files as a standard unified diff.  This can be piped through many
 
126
programs such as ``patch``, ``diffstat``,
 
127
``filterdiff`` and ``colordiff``::
258
128
 
259
129
    % bzr diff
260
 
    === added file 'hello.txt'
261
 
    --- hello.txt   1970-01-01 00:00:00 +0000
262
 
    +++ hello.txt   2005-10-18 14:23:29 +0000
263
 
    @@ -0,0 +1,1 @@
 
130
    *** added file 'hello.txt'
 
131
    --- /dev/null 
 
132
    +++ hello.txt 
 
133
    @@ -1,0 +1,1 @@
264
134
    +hello world
265
135
 
266
 
 
267
 
With the ``-r`` option, the tree is compared to an earlier revision, or
268
 
the differences between two versions are shown::
269
 
 
270
 
    % bzr diff -r 1000..          # everything since r1000
271
 
    % bzr diff -r 1000..1100      # changes from 1000 to 1100
272
 
 
273
 
The ``--diff-options`` option causes bzr to run the external diff program,
274
 
passing options.  For example::
275
 
 
276
 
    % bzr diff --diff-options --side-by-side foo
277
 
 
278
 
Some projects prefer patches to show a prefix at the start of the path
279
 
for old and new files.  The ``--prefix`` option can be used to provide
280
 
such a prefix.
281
 
As a shortcut, ``bzr diff -p1`` produces a form that works with the
282
 
command ``patch -p1``.
 
136
With the ``-r`` option, the tree is compared to an earlier
 
137
revision.
 
138
 
 
139
[TODO: options to run external diff; to get context diff or other
 
140
formats; to diff only selected files; to compare two historical
 
141
revisions.]
 
142
 
283
143
 
284
144
 
285
145
Committing changes
286
146
==================
287
147
 
288
 
When the working tree state is satisfactory, it can be **committed** to
289
 
the branch, creating a new revision holding a snapshot of that state.
290
 
 
291
 
bzr commit
292
 
----------
293
 
 
294
 
The **commit** command takes a message describing the changes in the
295
 
revision.  It also records your userid, the current time and timezone, and
296
 
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
298
 
message; in most shells you can enter this just by leaving the quotes open
299
 
at the end of the line.
300
 
 
301
 
::
 
148
When the working tree state is satisfactory, it can be
 
149
*committed* to the branch, creating a new revision holding a
 
150
snapshot of that state.  
 
151
 
 
152
The ``commit`` command takes a message describing the changes
 
153
in the revision.  It also records your userid, the current time and
 
154
timezone, and the inventory and contents of the tree.  The commit
 
155
message is specified by the ``-m`` or ``--message`` option.
 
156
You can enter a multi-line commit message; in most shells you can
 
157
enter this just by leaving the quotes open at the end of the line. ::
302
158
 
303
159
    % bzr commit -m "added my first file"
304
160
 
305
 
You can also use the ``-F`` option to take the message from a file.  Some
306
 
people like to make notes for a commit message while they work, then
307
 
review the diff to make sure they did what they said they did.  (This file
308
 
can also be useful when you pick up your work after a break.)
309
 
 
310
 
Message from an editor
311
 
----------------------
312
 
 
313
 
If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
314
 
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
317
 
override either of the above mentioned editor options.  If you quit the
318
 
editor without making any changes, the commit will be cancelled.
319
 
 
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.
325
 
 
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.
333
 
 
334
 
Marking bugs as fixed
335
 
---------------------
336
 
 
337
 
Many changes to a project are as a result of fixing bugs. Bazaar can keep
338
 
metadata about bugs you fixed when you commit them. To do this you use the
339
 
``--fixes`` option. This option takes an argument that looks like this::
340
 
 
341
 
    % bzr commit --fixes <tracker>:<id>
342
 
 
343
 
Where ``<tracker>`` is an identifier for a bug tracker and ``<id>`` is an
344
 
identifier for a bug that is tracked in that bug tracker. ``<id>`` is usually
345
 
a number. Bazaar already knows about a few popular bug trackers. They are 
346
 
bugs.launchpad.net, bugs.debian.org, and bugzilla.gnome.org. These trackers
347
 
have their own identifiers: lp, deb, and gnome respectively. For example,
348
 
if you made a change to fix the bug #1234 on bugs.launchpad.net, you would
349
 
use the following command to commit your fix::
350
 
 
351
 
    % bzr commit -m "fixed my first bug" --fixes lp:1234
352
 
 
353
 
For more information on this topic or for information on how to configure
354
 
other bug trackers please read `Bug Tracker Settings`_.
355
 
 
356
 
.. _Bug Tracker Settings: ../user-reference/index.html#bug-tracker-settings
357
 
 
358
 
Selective commit
359
 
----------------
360
 
 
361
 
If you give file or directory names on the commit command line then only
362
 
the changes to those files will be committed.  For example::
363
 
 
364
 
    % bzr commit -m "documentation fix" commit.py
365
 
 
366
 
By default bzr always commits all changes to the tree, even if run from a
367
 
subdirectory.  To commit from only the current directory down, use::
368
 
 
369
 
    % bzr commit .
 
161
[TODO: commit message interactively, through an editor or from a
 
162
file.]
 
163
 
 
164
[TODO: commit only selected files, including renamed/added/deleted
 
165
files.]
 
166
 
370
167
 
371
168
 
372
169
Removing uncommitted changes
373
170
============================
374
171
 
375
172
If you've made some changes and don't want to keep them, use the
376
 
**revert** command to go back to the previous head version.  It's a good
377
 
idea to use ``bzr diff`` first to see what will be removed. By default the
378
 
revert command reverts the whole tree; if file or directory names are
379
 
given then only those ones will be affected. ``bzr revert`` also clears the
380
 
list of pending merges revisions.
 
173
``revert`` command to go back to the previous head version.  It's a
 
174
good idea to use ``bzr diff`` first to see what will be removed. 
 
175
By default the revert command reverts the whole tree; if file or
 
176
directory names are given then only those ones will be affected.
 
177
revert also clears the list of pending merges revisions.
 
178
 
 
179
 
 
180
 
381
181
 
382
182
 
383
183
Ignoring files
384
184
==============
385
185
 
386
 
The .bzrignore file
387
 
-------------------
388
 
 
389
 
Many source trees contain some files that do not need to be versioned,
390
 
such as editor backups, object or bytecode files, and built programs.  You
391
 
can simply not add them, but then they'll always crop up as unknown files.
392
 
You can also tell bzr to ignore these files by adding them to a file
393
 
called ``.bzrignore`` at the top of the tree.
394
 
 
395
 
This file contains a list of file wildcards (or "globs"), one per line.
396
 
Typical contents are like this::
 
186
Many source trees contain some files that do not need to be
 
187
versioned, such as editor backups, object or bytecode files, and built
 
188
programs.  You can simply not add them, but then they'll always crop
 
189
up as unknown files.  You can also tell bzr to ignore these files by
 
190
adding them to a file called ``.bzrignore`` at the top of the
 
191
tree.
 
192
 
 
193
This file contains a list of file wildcards (or "globs"), one
 
194
per line.  Typical contents are like this::
397
195
 
398
196
    *.o
399
197
    *~
400
198
    *.tmp
401
199
    *.py[co]
402
200
 
403
 
If a glob contains a slash, it is matched against the whole path from the
404
 
top of the tree; otherwise it is matched against only the filename.  So
405
 
the previous example ignores files with extension ``.o`` in all
406
 
subdirectories, but this example ignores only ``config.h`` at the top level
407
 
and HTML files in ``doc/``::
 
201
If a glob contains a slash, it is matched against the whole path
 
202
from the top of the tree; otherwise it is matched against only the
 
203
filename.  So the previous example ignores ``*.o`` in all
 
204
subdirectories, but this example ignores only config.h at the top
 
205
level and HTML files in ``doc/``::
408
206
 
409
207
    ./config.h
410
208
    doc/*.html
411
209
 
412
 
To get a list of which files are ignored and what pattern they matched,
413
 
use ``bzr ignored``::
 
210
To get a list of which files are ignored and what pattern they matched, use ``bzr ignored``::
414
211
 
415
212
    % bzr ignored
416
 
    config.h                 ./config.h
417
 
    configure.in~            *~
418
 
 
419
 
It is OK to have either an ignore pattern match a versioned file, or to
420
 
add an ignored file.  Ignore patterns have no effect on versioned files;
421
 
they only determine whether unversioned files are reported as unknown or
422
 
ignored.
423
 
 
424
 
The ``.bzrignore`` file should normally be versioned, so that new copies
425
 
of the branch see the same patterns::
 
213
    config.h                                           ./config.h
 
214
    configure.in~                                      *~
 
215
 
 
216
It is OK to have an ignore pattern match a versioned file, or to
 
217
add an ignored file.  Ignore patterns have no effect on versioned
 
218
files; they only determine whether unversioned files are reported as
 
219
unknown or ignored.
 
220
 
 
221
The ``.bzrignore`` file should normally be versioned, so that new
 
222
copies of the branch see the same patterns::
426
223
 
427
224
    % bzr add .bzrignore
428
225
    % bzr commit -m "Add ignore patterns"
429
226
 
430
227
 
431
 
bzr ignore
432
 
----------
433
 
 
434
 
As an alternative to editing the ``.bzrignore`` file, you can use the
435
 
``bzr ignore`` command. The ``bzr ignore`` command takes filenames and/or
436
 
patterns as arguments and then adds them to the ``.bzrignore`` file. If a
437
 
``.bzrignore`` file does not exist the ``bzr ignore`` command will
438
 
automatically create one for you, and implicitly add it to be versioned::
439
 
 
440
 
    % bzr ignore tags
441
 
    % bzr status
442
 
    added:
443
 
      .bzrignore
444
 
 
445
 
Just like when editing the ``.bzrignore`` file on your own, you should
446
 
commit the automatically created ``.bzrignore`` file::
447
 
 
448
 
    % bzr commit -m "Added tags to ignore file"
449
 
 
450
 
 
451
 
Global ignores
452
 
--------------
453
 
 
454
 
There are some ignored files which are not project specific, but more user
455
 
specific. Things like editor temporary files, or personal temporary files.
456
 
Rather than add these ignores to every project, bzr supports a global
457
 
ignore file in ``~/.bazaar/ignore`` [1]_. It has the same syntax as the
458
 
per-project ignore file.
459
 
 
460
 
 
461
228
Examining history
462
229
=================
463
230
 
464
231
bzr log
465
232
-------
466
233
 
467
 
The ``bzr log`` command shows a list of previous revisions. The ``bzr log
468
 
--forward`` command does the same in chronological order to get most
469
 
recent revisions printed at last.
470
 
 
471
 
As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
472
 
 
473
 
    % bzr log -r 1000..          # Revision 1000 and everything after it
474
 
    % bzr log -r ..1000          # Everything up to and including r1000
475
 
    % bzr log -r 1000..1100      # changes from 1000 to 1100
476
 
    % bzr log -r 1000            # The changes in only revision 1000
 
234
The ``log`` command shows a list of previous revisions.
477
235
 
478
236
 
479
237
Branch statistics
480
238
=================
481
239
 
482
 
The ``bzr info`` command shows some summary information about the working
483
 
tree and the branch history.
 
240
The ``bzr info`` command shows some summary information about
 
241
the working tree and the branch history.  
484
242
 
485
243
 
486
244
Versioning directories
487
245
======================
488
246
 
489
 
bzr versions files and directories in a way that can keep track of renames
490
 
and intelligently merge them::
 
247
bzr versions files and directories in a way that can keep track of
 
248
renames and intelligently merge them::
491
249
 
492
250
    % mkdir src
493
251
    % echo 'int main() {}' > src/simple.c
494
252
    % bzr add src
495
 
    added src
496
 
    added src/simple.c
497
 
    % bzr status
498
 
    added:
499
 
      src/
500
 
      src/simple.c
 
253
    % bzr status
 
254
    A       src/
 
255
    ?       src/simple.c
 
256
    % bzr add src/simple.c
 
257
    % bzr status
 
258
    A       src/
 
259
    A       src/simple.c
501
260
 
502
261
 
503
262
Deleting and removing files
504
263
===========================
505
264
 
506
 
You can delete files or directories by just deleting them from the working
507
 
directory.  This is a bit different to CVS, which requires that you also
508
 
do ``cvs remove``.
509
 
 
510
 
``bzr remove`` makes the file un-versioned, but may or may not delete the
511
 
working copy [2]_.  This is useful when you add the wrong file, or decide that
512
 
a file should actually not be versioned.
513
 
 
514
 
::
 
265
You can delete files or directories by just deleting them from the
 
266
working directory.  This is a bit different to CVS, which requires
 
267
that you also do *cvs remove*.
 
268
 
 
269
*bzr remove* makes the file un-versioned, but does not
 
270
delete the working copy.  This is useful when you add the wrong file,
 
271
or decide that a file should actually not be versioned. ::
515
272
 
516
273
    % rm -r src
517
274
    % bzr remove -v hello.txt
518
275
    ?       hello.txt
519
276
    % bzr status
520
 
    removed:
521
 
      hello.txt
522
 
      src/
523
 
      src/simple.c
524
 
    unknown:
525
 
      hello.txt
526
 
 
527
 
If you remove the wrong file by accident, you can use ``bzr revert`` to
528
 
restore it.
 
277
    ?       hello.txt
 
278
    D       src/
 
279
    D       src/simple.c
529
280
 
530
281
 
531
282
Branching
532
283
=========
533
284
 
534
 
Often rather than starting your own project, you will want to submit a
535
 
change to an existing project.  To do this, you'll need to get a copy of
536
 
the existing branch.  Because this new copy is potentially a new branch,
537
 
the command is called **branch**::
 
285
Often rather than starting your own project, you will want to
 
286
submit a change to an existing project.  You can get a copy of an
 
287
existing branch by copying its directory, expanding a tarball, or by a
 
288
remote copy using something like rsync.  You can also use bzr to fetch
 
289
a copy.  Because this new copy is potentially a new branch, the
 
290
command is called *branch*::
538
291
 
539
 
    % bzr branch lp:bzr bzr.dev
 
292
    % bzr branch http://bazaar-ng.org/bzr/bzr.dev
540
293
    % cd bzr.dev
541
294
 
542
 
This copies down the complete history of this branch, so we can do all
543
 
operations on it locally: log, annotate, making and merging branches.
544
 
There will be an option to get only part of the history if you wish.
545
 
 
546
 
You can also get a copy of an existing branch by copying its directory,
547
 
expanding a tarball, or by a remote copy using something like rsync.
 
295
This copies down the complete history of this branch, so we can
 
296
do all operations on it locally: log, annotate, making and merging
 
297
branches.  There will be an option to get only part of the history if
 
298
you wish.
 
299
 
 
300
 
548
301
 
549
302
Following upstream changes
550
303
==========================
551
304
 
552
 
You can stay up-to-date with the parent branch by "pulling" in their
553
 
changes::
 
305
You can stay up-to-date with the parent branch by *pulling*
 
306
in their changes::
554
307
 
555
308
    % bzr pull
556
309
 
557
 
After this change, the local directory will be a mirror of the source. This
558
 
includes the ''revision-history'' - which is a list of the commits done in
559
 
this branch, rather than merged from other branches.
560
 
 
561
 
This command only works if your local (destination) branch is either an
562
 
older copy of the parent branch with no new commits of its own, or if the
563
 
most recent commit in your local branch has been merged into the parent
564
 
branch.
565
 
 
566
 
Merging from related branches
567
 
=============================
568
 
 
569
 
If two branches have diverged (both have unique changes) then ``bzr
570
 
merge`` is the appropriate command to use. Merge will automatically
571
 
calculate the changes that exist in the branch you're merging from that
572
 
are not in your branch and attempt to apply them in your branch.
573
 
 
574
 
::
575
 
 
576
 
  % bzr merge URL
577
 
 
578
 
 
579
 
If there is a conflict during a merge, 3 files with the same basename
580
 
are created. The filename of the common base is appended with ".BASE",
581
 
the filename of the file containing your changes is appended with
582
 
".THIS" and the filename with the changes from the other tree is
583
 
appended with ".OTHER".  Using a program such as kdiff3, you can now
584
 
comfortably merge them into one file.  In order to commit you have to
585
 
rename the merged file (".THIS") to the original file name.  To
586
 
complete the conflict resolution you must use the resolve command,
587
 
which will remove the ".OTHER" and ".BASE" files.  As long as there
588
 
exist files with .BASE, .THIS or .OTHER the commit command will
589
 
report an error.
590
 
 
591
 
::
592
 
 
593
 
  % kdiff3 file.BASE file.OTHER file.THIS
594
 
  % mv file.THIS file
595
 
  % bzr resolve file
596
 
 
597
 
[**TODO**: explain conflict markers within files]
598
 
 
599
 
 
600
 
Publishing your branch
601
 
======================
602
 
 
603
 
You don't need a special server to publish a bzr branch, just a normal web
604
 
server.  Just mirror the files to your server, including the .bzr
605
 
directory.  One can push a branch (or the changes for a branch) by one of
606
 
the following three methods:
607
 
 
608
 
* The best method is to use bzr itself to do it.
609
 
 
610
 
  ::
611
 
 
612
 
    % bzr push bzr+ssh://servername.com/path/to/directory
613
 
 
614
 
  (The destination directory must already exist unless the
615
 
  ``--create-prefix`` option is used.)
616
 
 
617
 
* Another option is the ``rspush`` plugin that comes with BzrTools, which
618
 
  uses rsync to push the changes to the revision history and the working
619
 
  tree.
620
 
 
621
 
* You can also copy the files around manually, by sending a tarball, or using
622
 
  rsync, or other related file transfer methods.  This is usually less safe
623
 
  than using ``push``, but may be faster or easier in some situations.
624
 
 
625
 
 
626
 
Moving changes between trees
627
 
============================
628
 
 
629
 
It happens to the best of us: sometimes you'll make changes in the wrong
630
 
tree.  Maybe because you've accidentally started work in the wrong directory,
631
 
maybe because as you're working, the change turns out to be bigger than you
632
 
expected, so you start a new branch for it.
633
 
 
634
 
To move your changes from one tree to another, use
635
 
 
636
 
::
637
 
 
638
 
  % cd NEWDIR
639
 
  % bzr merge --uncommitted OLDDIR
640
 
 
641
 
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
642
 
It will not apply committed changes, even if they could be applied to NEWDIR
643
 
with a regular merge.  The changes will remain in OLDDIR, but you can use ``bzr
644
 
revert OLDDIR`` to remove them, once you're satisfied with NEWDIR.
645
 
 
646
 
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
647
 
The more different they are, the greater the chance of conflicts.
 
310
This only works if your local branch includes only changes from the
 
311
parent branch.  Otherwise, the branches are said to have *diverged*,
 
312
and they must be merged instead.