/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to tutorial.txt

  • Committer: Robert Collins
  • Date: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
mergeĀ fromĀ upstream

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