10
Bazaar is a distributed version control system that makes it easier for
11
people to work together on software projects.
13
Over the next five minutes, you'll learn how to put your files under
14
version control, how to record changes to them, examine your work, publish
15
it and send your work for merger into a project's trunk.
17
If you'd prefer a more detailed introduction, take a look at
24
This guide doesn't describe how to install Bazaar but it's usually very
25
easy. You can find installation instructions at:
27
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
28
- **Windows:** `installation instructions`_.
29
- **Mac OS X:** `install using MacPorts`_.
31
For other platforms and to install from source code, see the Downloads_
32
and Installation_ pages.
34
.. _installation instructions: http://bazaar-vcs.org/WindowsDownloads
35
.. _install using MacPorts: http://bazaar-vcs.org/MacPorts
36
.. _Downloads: http://bazaar-vcs.org/Download
37
.. _Installation: http://bazaar-vcs.org/InstallationFAQ
43
Before you start working, it is good to tell Bazaar who you are. That
44
way your work is properly identified in revision logs.
46
Using your name and email address, instead of John Doe's, type::
48
$ bzr whoami "John Doe <john.doe@gmail.com>"
50
Bazaar will now create or modify a configuration file, including your
51
name and email address.
53
Now, check that your name and email address are correctly registered::
56
John Doe <john.doe@gmail.com>
59
Putting files under version control
60
===================================
62
Let's create a directory and some files to use with Bazaar::
67
$ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
69
**Note for Windows users:** use Windows Explorer to create your
70
directories, then right-click in those directories and select
71
``New file`` to create your files.
73
Now get Bazaar to initalize itself in your project directory::
77
If it looks like nothing happened, don't worry. Bazaar has created a
78
branch_ where it will store your files and their revision histories.
80
.. _branch: http://bazaar-vcs.org/Branch
82
The next step is to tell Bazaar which files you want to track. Running
83
``bzr add`` will recursively add everything in the project::
90
added subdirectory/test4.txt
92
Next, take a snapshot of your files by committing them to your branch. Add
93
a message to explain why you made the commit::
95
$ bzr commit -m "Initial import"
97
As Bazaar is a distributed version control system, it doesn't need to
98
connect to a central server to make the commit. Instead, Bazaar stores your
99
branch and all its commits inside the directory you're working with; look
100
for the ``.bzr`` sub-directory.
103
Making changes to your files
104
============================
106
Let's change a file and commit those changes to your branch.
108
Edit ``test1.txt`` in your favourite editor, then check what have you done::
111
=== modified file 'test1.txt'
112
--- test1.txt 2007-10-08 17:56:14 +0000
113
+++ test1.txt 2007-10-08 17:46:22 +0000
117
Commit your work to the Bazaar branch::
119
$ bzr commit -m 'Added first line of text'
120
Committed revision 2.
123
Viewing the revision log
124
========================
126
You can see the history of your branch by browsing its log::
129
------------------------------------------------------------
131
committer: John Doe <john.doe@gmail.com>
132
branch nick: myproject
133
timestamp: Mon 2007-10-08 17:56:14 +0000
135
Added first line of text
136
------------------------------------------------------------
138
committer: John Doe <john.doe@gmail.com>
139
branch nick: myproject
140
timestamp: Mon 2006-10-08 17:46:22 +0000
145
Publishing your branch with sftp
146
================================
148
There are a couple of ways to publish your branch. If you already have
149
an SFTP server or are comfortable setting one up, you can publish your
152
Otherwise, skip to the next section to publish with Launchpad_, a free
153
hosting service for Bazaar.
155
.. _Launchpad: https://launchpad.net/
157
Let's assume you want to publish your branch at ``www.example.com/myproject``::
159
$ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
160
2 revision(s) pushed.
162
Bazaar will create a ``myproject`` directory on the remote server and
163
push your branch to it.
165
**Note:** to use sftp, you may need to install ``paramiko`` and
166
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
168
Now anyone can create their own copy of your branch by typing::
170
$ bzr branch http://www.example.com/myproject
173
Publishing your branch with Launchpad
174
=====================================
176
Launchpad is a suite of development and hosting tools for free
177
software projects. You can use it to publish your branch.
179
If you don't have a Launchpad account, follow the `account signup guide`_
180
and `register an SSH key`_ in your new Launchpad account.
182
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
183
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
185
Replacing ``john.doe`` with your own Launchpad username, type::
187
$ bzr push bzr+ssh://john.doe@bazaar.launchpad.net/~john.doe/+junk/myproject
189
**Note:** ``+junk`` means that this branch isn't associated with any particular
190
project in Launchpad.
192
Now, anyone can create their own copy of your branch by typing::
194
$ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject
196
You can also see information about your branch, including its revision
197
history, at https://code.launchpad.net/people/+me/+junk/myproject
200
Creating your own copy of another branch
201
========================================
203
To work with someone else's code, you can make your own copy of their
204
branch. Let's take a real-world example, Bazaar's GTK interface::
206
$ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john
207
Branched 292 revision(s).
209
Bazaar will download all the files and complete revision history from the
210
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
212
Now, you have your own copy of the branch and can commit changes with
213
or without a net connection. You can share your branch at any time by
214
publishing it and, if the bzr-gtk team want to use your work, Bazaar
215
makes it easy for them to merge your branch back into their trunk branch.
218
Updating your branch from the main branch
219
=========================================
221
While you commit changes to your branch, it's likely that other people will
222
also continue to commit code to the parent branch.
224
To make sure your branch stays up to date, you should merge changes from
225
the parent into your personal branch::
228
Using saved location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
229
All changes applied successfully.
231
Check what has changed::
235
If you're happy with the changes, you can commit them to your personal
238
$ bzr commit -m 'Merge from main branch'
239
Committed revision 295.
242
Merging your work into the parent branch
243
========================================
245
After you've worked on your personal branch of bzr-gtk, you may want to
246
send your changes back upstream to the project. The easiest way is to
247
use a merge directive.
249
A merge directive is a machine-readable request to perform a
250
particular merge. It usually contains a patch preview of the merge
251
and either contains the necessary revisions, or provides a branch
252
where they can be found.
254
Replacing ``mycode.patch``, create your merge directive::
256
$ bzr send -o mycode.patch
257
Using saved location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
259
You can now email the merge directive to the bzr-gtk project who, if
260
they choose, can use it merge your work back into the parent branch.
266
You can find out more about Bazaar in the `Bazaar user guide <../../index.html>`_.
268
To learn about Bazaar on the command-line::
272
To learn about Bazaar commands::
276
To learn about the ''foo'' topic or command::
added
removed
doc/en/mini-tutorial/index.txt
