~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tutorial.txt

  • Committer: Aaron Bentley
  • Date: 2006-02-22 14:39:42 UTC
  • mto: (2027.1.2 revert-subpath-56549)
  • mto: This revision was merged to the branch mainline in revision 1570.
  • Revision ID: abentley@panoramicfeedback.com-20060222143942-ae72299f2de66767
Fixed build_tree with symlinks

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 http://bazaar.canonical.com/IntroductionToBzr
 
6
.. but has been moved into the source tree so it can be kept in sync with
 
7
.. the source and possibly automatically checked.
 
8
 
1
9
==================
2
10
Bazaar-NG Tutorial
3
11
==================
4
12
 
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
Current for bzr-0.7pre, 2006-01-06.
10
14
 
11
15
 
12
16
Introduction
13
17
============
14
18
 
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
 
 
 
19
If you are already familiar with decentralized revision control, then please feel free to skip ahead to "Introducing Yourself to Bazaar-NG". If, on the other hand, you are familiar with revision control but not decentralized revision control, then please start at "How DRCS is different." Otherwise, get some coffee or tea, get comfortable and get ready to catch up. 
 
20
 
 
21
The Purposes of Revision Control
 
22
================================
 
23
 
 
24
Odds are that you have worked on some sort of textual data -- the sources to a program, web sites or the config files that Unix system administrators have to deal with in /etc. The chances are also good that you have made some sort of mistake that you deeply regretted. Perhaps you deleted the configuration file for your mailserver or perhaps mauled the source code for a pet project. Whatever happened, you have just deleted important information that you would desperately like to get back. If this has ever happened to you, then you are probably ready for Bazaar-NG.
 
25
 
 
26
Revision control systems (which I'll henceforth call RCS) such as Bazaar-NG give you the ability to track changes for a directory by turning it into something slightly more complicated than a directory that we call a **branch**. The branch not only stores how the directory looks right now, but also how it looked at various points in the past. Then, when you do something you wish you hadn't, you can restore the directory to the way it looked at some point in the past.
 
27
 
 
28
Revision control systems give users the ability to save changes to a branch by "committing a **revision**". The revision created is essentially a summary of the changes that were made since the last time the tree was saved. 
 
29
 
 
30
These revisions have other uses as well. For example, one can comment revisions to record what the recent set of changes meant by providing an optional log message. Real life log messages include things like "Fixed the web template to close the table" and "Added sftp suppport. Fixes #595"
 
31
        
 
32
We keep these logs so that if later there is some sort of problem with sftp, we can figure out when the problem probably happened. 
 
33
 
 
34
How DRCS is Different
 
35
---------------------
 
36
 
 
37
Many Revision Control Systems (RCS) are stored on servers. If one wants to work on the code stored within an RCS, then one needs to connect to the server and "checkout" the code. Doing so gives one a directory in which a person can make changes and then commit. The RCS client then connects to the RCS server and stores the changes. This method is known as the centralized model. 
 
38
 
 
39
The centralized model can have some drawbacks. A centralized RCS requires that one is able to connect to the server whenever one wants to do version control work. This can be a bit of a problem if your server on some other machine on the internet and you are not. Or, worse yet, you ''are'' on the internet but the server is missing!
 
40
 
 
41
Decentralized Revision Control Systems (which I'll call DRCS after this point) deal with this problem by keeping branches on the same machine as the client. In Bazaar-NG's case, the branch is kept in the same place as the code that is being version controlled. This allows the user to save his changes (**commit**) whenever he wants -- even if he is offline. The user only needs internet access when he wants to access the changes in someone else's branch that are somewhere else.
 
42
 
 
43
 
 
44
A common requirement that many people have is the need to keep track of the changes for a directory such as file and subdirectory changes. Performing this tracking by hand is a awkward process that over time becomes unwieldy. That is, until one considers version control tools such as Bazaar-NG. These tools automate the process of storing data by creating a **revision** of the directory tree whenever the user asks. 
 
45
 
 
46
Revision control software such as Bazaar-NG can do much more than just storage and performing undo.  For example, with Bazaar-NG developer can take the modifications in one branch of software and apply them to another, related, branch -- even if those changes exist in a branch owned by somebody else. This allows developers to cooperate without giving write access to repository.
 
47
 
 
48
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. By branching, Bazaar-NG allows multiple people to cooperate on the evolution of a project, without all needing to work in strict lock-step.  Branching can be useful even for a single developer.
 
49
 
 
50
Introducing yourself to Bazaar-NG
 
51
=================================
 
52
 
 
53
Bazaar-NG installs a single new command, **bzr**.  Everything else is a subcommand of this.  You can get some help with `bzr help`.  There will be more in the future.
 
54
 
 
55
One function of a version control system is to keep track of who changed what.  In a decentralized system, that requires an identifier for each author that is globally unique.  Most people already have one of these: an email address. Bzr is smart enough to automatically generate an email address by looking up your username and hostname. If you don't like the guess that Bazaar-NG makes, then three options exist:
 
56
 
 
57
 1. (**Bazaar-NG 0.6 and later**). Setting the email address in the
 
58
 ``~/.bazaar/bazaar.conf`` by adding the following lines. Please note that
 
59
 ``[DEFAULT]`` is case sensitive::
 
60
 
 
61
    [DEFAULT]
 
62
    email= Your Name <email@isp.com>
 
63
 
 
64
 1. (**Bazaar-NG 0.6 and later**) Override the previous setting on a
 
65
 branch by branch basis by creating a branch section in
 
66
 ``~/.bazaar/branches.conf`` by adding the following lines::
 
67
 
 
68
    [/the/directory/to/the/branch]
 
69
    email=Your Name <email@isp.com>
 
70
 
 
71
 1. Overriding the two previous options by setting the global environment
 
72
 variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence) to your full email address.
60
73
 
61
74
Creating a branch
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::
 
75
=================
 
76
 
 
77
History is by default stored in the .bzr directory of the branch. There will be a facility to store it in a separate repository, which may be remote.  We create a new branch by running **bzr init** in an existing directory::
69
78
 
70
79
    % mkdir tutorial
71
80
    % cd tutorial
72
81
    % ls -a
73
 
    ls -a
74
82
    ./  ../
75
83
    % pwd
76
84
    /home/mbp/work/bzr.test/tutorial
80
88
    ./  ../  .bzr/
81
89
    %
82
90
 
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::
 
91
As for CVS, there are three classes of file: unknown, ignored, and versioned.  The **add** command makes a file versioned: that is, changes to it will be recorded by the system::
86
92
 
87
93
    % echo 'hello world' > hello.txt
88
94
    % bzr status
89
 
    ?       hello.txt
 
95
    unknown:
 
96
      hello.txt
90
97
    % bzr unknowns
91
98
    hello.txt
92
 
    % bzr add -v hello.txt
93
 
    A       hello.txt
 
99
    % bzr add hello.txt
 
100
    added hello.txt
94
101
    % bzr unknowns
95
102
 
96
103
 
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
 
 
 
104
If you add the wrong file, simply use **bzr remove** to make it unversioned again.  This does not delete the working copy.
 
105
 
 
106
Branch locations
 
107
================
 
108
 
 
109
All history is stored in a branch, which is just an on-disk directory containing control files.  There is no repository or database as used in svn or svk.
 
110
 
 
111
  (There are proposals to add shared storage between related branches.)
 
112
 
 
113
You'll usually refer to branches on your computer's filesystem just by
 
114
giving the name of the directory containing the branch.  bzr also supports
 
115
accessing branches over http, for example::
 
116
 
 
117
    % bzr log http://bazaar-ng.org/bzr/bzr.dev/
 
118
 
 
119
By installing bzr plugins you can also access branches over the sftp or rsync protocols.
100
120
 
101
121
Reviewing changes
102
122
=================
103
123
 
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'::
 
124
Once you have completed some work, you will want to **commit** it to the version history.  It is good to commit fairly often: whenever you get a new feature working, fix a bug, or improve some code or documentation.  It's also a good practice to make sure that the code compiles and passes its test suite before committing, to make sure that every revision is a known-good state.  You can also review your changes, to make sure you're committing what you intend to, and as a chance to rethink your work before you permanently record it. 
 
125
 
 
126
Two bzr commands are particularly useful here: **status** and **diff**.  
 
127
 
 
128
bzr status
 
129
----------
 
130
 
 
131
The **status** command tells you what changes have been made to the
 
132
working directory since the last revision::
120
133
 
121
134
    % 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``::
 
135
    modified:
 
136
       foo
 
137
 
 
138
By default **bzr status** hides "boring" files that are either unchanged or ignored.  To see them too, use the --all option.  The status command can optionally be given the name of some files or directories to check.
 
139
 
 
140
bzr diff
 
141
--------
 
142
 
 
143
The **diff** command shows the full text of changes to all files as a standard unified diff.  This can be piped through many programs such as ''patch'', ''diffstat'', ''filterdiff'' and ''colordiff''::
128
144
 
129
145
    % bzr diff
130
146
    *** added file 'hello.txt'
133
149
    @@ -1,0 +1,1 @@
134
150
    +hello world
135
151
 
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
 
 
143
 
 
 
152
 
 
153
With the ''-r'' option, the tree is compared to an earlier revision, or
 
154
the differences between two versions are shown::
 
155
 
 
156
    % bzr diff -r 1000..          # everything since r1000
 
157
    % bzr diff -r 1000..1100      # changes from 1000 to 1100
 
158
 
 
159
The --diff-options option causes bzr to run the external diff program,
 
160
passing options.  For example::
 
161
 
 
162
    % bzr diff --diff-options --side-by-side foo
144
163
 
145
164
Committing changes
146
165
==================
147
166
 
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. ::
 
167
When the working tree state is satisfactory, it can be **committed** to the branch, creating a new revision holding a snapshot of that state.  
 
168
 
 
169
bzr commit
 
170
----------
 
171
 
 
172
The **commit** command takes a message describing the changes in the revision.  It also records your userid, the current time and timezone, and the inventory and contents of the tree.  The commit message is specified by the ''-m'' or ''--message'' option. You can enter a multi-line commit message; in most shells you can enter this just by leaving the quotes open at the end of the line.
 
173
 
 
174
::
158
175
 
159
176
    % bzr commit -m "added my first file"
160
177
 
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
 
 
 
178
You can also use the -F option to take the message from a file.  Some people like to make notes for a commit message while they work, then review the diff to make sure they did what they said they did.  (This file can also be useful when you pick up your work after a break.)
 
179
 
 
180
Message from an editor
 
181
======================
 
182
 
 
183
If you use neither the `-m` nor the `-F` option then bzr will open an editor for you to enter a message.  The editor to run is controlled by your `$EDITOR` environment variable or (Post Bazaar-NG 0.6) email setting in .  If you quit the editor without making any changes, the commit will be cancelled.
 
184
 
 
185
Selective commit
 
186
----------------
 
187
 
 
188
If you give file or directory names on the commit command line then only
 
189
the changes to those files will be committed.  For example::
 
190
 
 
191
    % bzr commit -m "documentation fix" commit.py
 
192
 
 
193
By default bzr always commits all changes to the tree, even if run from a
 
194
subdirectory.  To commit from only the current directory down, use::
 
195
 
 
196
    % bzr commit .
167
197
 
168
198
 
169
199
Removing uncommitted changes
170
200
============================
171
201
 
172
 
If you've made some changes and don't want to keep them, use the
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
 
 
181
 
 
 
202
If you've made some changes and don't want to keep them, use the **revert** command to go back to the previous head version.  It's a good idea to use **bzr diff** first to see what will be removed. By default the revert command reverts the whole tree; if file or directory names are given then only those ones will be affected. **revert** also clears the list of pending merges revisions.
182
203
 
183
204
Ignoring files
184
205
==============
185
206
 
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.
 
207
Many source trees contain some files that do not need to be versioned, such as editor backups, object or bytecode files, and built programs.  You can simply not add them, but then they'll always crop up as unknown files.  You can also tell bzr to ignore these files by adding them to a file called ''.bzrignore'' at the top of the tree.
192
208
 
193
 
This file contains a list of file wildcards (or "globs"), one
194
 
per line.  Typical contents are like this::
 
209
This file contains a list of file wildcards (or "globs"), one per line.  Typical contents are like this::
195
210
 
196
211
    *.o
197
212
    *~
198
213
    *.tmp
199
214
    *.py[co]
200
215
 
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/``::
 
216
If a glob contains a slash, it is matched against the whole path from the
 
217
top of the tree; otherwise it is matched against only the filename.  So
 
218
the previous example ignores files with extension ``.o`` in all
 
219
subdirectories, but this example ignores only config.h at the top level
 
220
and HTML files in ``doc/``::
206
221
 
207
222
    ./config.h
208
223
    doc/*.html
209
224
 
210
 
To get a list of which files are ignored and what pattern they matched, use ``bzr ignored``::
 
225
To get a list of which files are ignored and what pattern they matched, use ''bzr ignored''::
211
226
 
212
227
    % 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::
 
228
    config.h                 ./config.h
 
229
    configure.in~            *~
 
230
 
 
231
It is OK to have either an ignore pattern match a versioned file, or to add an ignored file.  Ignore patterns have no effect on versioned files; they only determine whether unversioned files are reported as unknown or ignored.
 
232
 
 
233
The ''.bzrignore'' file should normally be versioned, so that new copies of the branch see the same patterns::
223
234
 
224
235
    % bzr add .bzrignore
225
236
    % bzr commit -m "Add ignore patterns"
231
242
bzr log
232
243
-------
233
244
 
234
 
The ``log`` command shows a list of previous revisions.
 
245
The **bzr log** command shows a list of previous revisions. The **bzr log --forward** command does the same in chronological order to get most recent revisions printed at last.
 
246
 
 
247
As with bzr diff, bzr log supports the -r argument::
 
248
 
 
249
    % bzr log -r 1000..          # Revision 1000 and everything after it
 
250
    % bzr log -r ..1000          # Everything up to and including revision % 1000
 
251
    % bzr log -r 1000..1100      # changes from 1000 to 1100
 
252
    % bzr log -r 1000            # The changes in only revision 1000
235
253
 
236
254
 
237
255
Branch statistics
238
256
=================
239
257
 
240
 
The ``bzr info`` command shows some summary information about
241
 
the working tree and the branch history.  
 
258
The **bzr info** command shows some summary information about the working tree and the branch history.  
242
259
 
243
260
 
244
261
Versioning directories
245
262
======================
246
263
 
247
 
bzr versions files and directories in a way that can keep track of
248
 
renames and intelligently merge them::
 
264
bzr versions files and directories in a way that can keep track of renames and intelligently merge them::
249
265
 
250
266
    % mkdir src
251
267
    % echo 'int main() {}' > src/simple.c
261
277
 
262
278
Deleting and removing files
263
279
===========================
264
 
 
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. ::
 
280
You can delete files or directories by just deleting them from the working directory.  This is a bit different to CVS, which requires that you also do **cvs remove**.
 
281
 
 
282
        **bzr remove** makes the file un-versioned, but does not delete the working copy.  This is useful when you add the wrong file, or decide that a file should actually not be versioned. 
 
283
 
 
284
::
272
285
 
273
286
    % rm -r src
274
287
    % bzr remove -v hello.txt
278
291
    D       src/
279
292
    D       src/simple.c
280
293
 
 
294
If you remove the wrong file by accident, you can use **bzr revert** to restore it.
 
295
 
281
296
 
282
297
Branching
283
298
=========
284
299
 
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*::
 
300
Often rather than starting your own project, you will want to submit a change to an existing project.  You can get a copy of an existing branch by copying its directory, expanding a tarball, or by a remote copy using something like rsync.  You can also use bzr to fetch a copy.  Because this new copy is potentially a new branch, the command is called *branch*::
291
301
 
292
 
    % bzr branch http://bazaar-ng.org/bzr/bzr.dev
 
302
    % bzr branch http://bazaar-ng.org/bzr/bzr.dev 
293
303
    % cd bzr.dev
294
304
 
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
 
 
 
305
This copies down the complete history of this branch, so we can do all operations on it locally: log, annotate, making and merging branches.  There will be an option to get only part of the history if you wish.
301
306
 
302
307
Following upstream changes
303
308
==========================
304
309
 
305
 
You can stay up-to-date with the parent branch by *pulling*
306
 
in their changes::
 
310
You can stay up-to-date with the parent branch by "pulling" in their changes::
307
311
 
308
312
    % bzr pull
309
313
 
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.
 
314
After this change, the local directory will be a mirror of the source.
 
315
 
 
316
This command only works if your local (destination) branch includes only
 
317
changes from the parent branch and no commits of its own.  Otherwise, the
 
318
branches are said to have ''diverged'', and they must be merged instead.
 
319
 
 
320
Merging from related branches
 
321
=============================
 
322
 
 
323
If two branches have diverged (both have unique changes) then **bzr merge** is the appropriate command to use. Merge will automatically calculate the changes that exist in the branch you're merging from that are not in your branch and attempt to apply them in your branch.
 
324
 
 
325
::
 
326
 
 
327
  % bzr merge URL
 
328
 
 
329
 
 
330
If there is a conflict during a merge, 3 files with the same basename are created. The filename of the common base is appended with .BASE, the filename of the file containing your changes is appended .THIS and the filename with the changes from the other tree is appended .OTHER.
 
331
Using a program such as kdiff3, you can now comfortably merge them into one file. To commit you have to rename it to the original basename and delete the other two files. As long as there exist files with .BASE, .THIS or .OTHER the commit command will complain.
 
332
 
 
333
[**TODO**: explain conflict markers within files]
 
334
 
 
335
 
 
336
Publishing your branch
 
337
======================
 
338
You don't need a special server to publish a bzr branch, just a normal web server.  Just mirror the files to your server, including the .bzr directory.  One can push a branch (or the changes for a branch) by one of the following three methods:
 
339
 
 
340
 * Rsync:   rsync -avrz LOCALBRANCH  servername.com/this/directory/here
 
341
 * (Post 0.6): bzr push sftp://servername.com/this/directory/here (sftp://servername.com/this/directory/ must already exist)
 
342
 * The push plugin that comes with BzrTools
 
343