8
Bazaar is a distributed version control system that makes it easier for
9
people to work together on software projects.
11
Over the next five minutes, you'll learn how to put your files under
12
version control, how to record changes to them, examine your work, publish
13
it and send your work for merger into a project's trunk.
15
If you'd prefer a more detailed introduction, take a look at
22
This guide doesn't describe how to install Bazaar but it's usually very
23
easy. You can find installation instructions at:
25
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
26
- **Windows:** `installation instructions for Windows`_.
27
- **Mac OS X:** `installation instructions for Mac OS X`_.
29
For other platforms and to install from source code, see the Download_
30
and Installation_ pages.
32
.. _installation instructions for Windows: http://wiki.bazaar.canonical.com/WindowsDownloads
33
.. _installation instructions for Mac OS X: http://wiki.bazaar.canonical.com/MacOSXBundle
34
.. _Download: http://wiki.bazaar.canonical.com/Download
35
.. _Installation: http://wiki.bazaar.canonical.com/InstallationFaq
41
Before you start working, it is good to tell Bazaar who you are. That
42
way your work is properly identified in revision logs.
44
Using your name and email address, instead of John Doe's, type::
46
$ bzr whoami "John Doe <john.doe@gmail.com>"
48
Bazaar will now create or modify a configuration file, including your
49
name and email address.
51
Now, check that your name and email address are correctly registered::
54
John Doe <john.doe@gmail.com>
57
Putting files under version control
58
===================================
60
Let's create a directory and some files to use with Bazaar::
65
$ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
67
**Note for Windows users**: use Windows Explorer to create your
68
directories, then right-click in those directories and select
69
``New file`` to create your files.
71
Now get Bazaar to initialize itself in your project directory::
75
If it looks like nothing happened, don't worry. Bazaar has created a
76
branch_ where it will store your files and their revision histories.
78
.. _branch: http://wiki.bazaar.canonical.com/Branch
80
The next step is to tell Bazaar which files you want to track. Running
81
``bzr add`` will recursively add everything in the project::
88
added subdirectory/test4.txt
90
Next, take a snapshot of your files by committing them to your branch. Add
91
a message to explain why you made the commit::
93
$ bzr commit -m "Initial import"
95
As Bazaar is a distributed version control system, it doesn't need to
96
connect to a central server to make the commit. Instead, Bazaar stores your
97
branch and all its commits inside the directory you're working with; look
98
for the ``.bzr`` sub-directory.
101
Making changes to your files
102
============================
104
Let's change a file and commit that change to your branch.
106
Edit ``test1.txt`` in your favourite editor, then check what have you done::
109
=== modified file 'test1.txt'
110
--- test1.txt 2007-10-08 17:56:14 +0000
111
+++ test1.txt 2007-10-08 17:46:22 +0000
115
Commit your work to the Bazaar branch::
117
$ bzr commit -m "Added first line of text"
118
Committed revision 2.
121
Viewing the revision log
122
========================
124
You can see the history of your branch by browsing its log::
127
------------------------------------------------------------
129
committer: John Doe <john.doe@gmail.com>
130
branch nick: myproject
131
timestamp: Mon 2007-10-08 17:56:14 +0000
133
Added first line of text
134
------------------------------------------------------------
136
committer: John Doe <john.doe@gmail.com>
137
branch nick: myproject
138
timestamp: Mon 2006-10-08 17:46:22 +0000
143
Publishing your branch on Launchpad
144
===================================
146
Launchpad is a suite of development and hosting tools for
147
software projects. You can use it to publish your branch. (You can
148
also publish branches onto your own server or other hosting services.)
150
If you don't have a Launchpad account, follow the `account signup guide`_
151
and `register an SSH key`_ in your new Launchpad account.
153
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
154
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
156
Replacing ``john.doe`` with your own Launchpad username, type [#]_::
158
$ bzr push lp:~john.doe/+junk/myproject
160
.. [#] Use of the ``lp:`` URL scheme requires bzr 0.92 or later.
162
**Note**: ``+junk`` means that this branch isn't associated with any particular
163
project in Launchpad.
165
Now, anyone can create their own copy of your branch by typing::
167
$ bzr branch lp:~john.doe/+junk/myproject
169
You can also see information about your branch, including its revision
170
history, at https://code.launchpad.net/people/+me/+junk/myproject
175
Creating your own copy of another branch
176
========================================
178
To work with someone else's code, you can make your own copy of their
179
branch. Let's take a real-world example, Bazaar's GTK interface::
181
$ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
182
Branched 292 revision(s).
184
Bazaar will download all the files and complete revision history from the
185
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
187
Now, you have your own copy of the branch and can commit changes with
188
or without a net connection. You can share your branch at any time by
189
publishing it and, if the bzr-gtk team want to use your work, Bazaar
190
makes it easy for them to merge your branch back into their trunk branch.
193
Updating your branch from the main branch
194
=========================================
196
While you commit changes to your branch, it's likely that other people will
197
also continue to commit code to the parent branch.
199
To make sure your branch stays up to date, you should merge changes from
200
the parent into your personal branch::
203
Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
204
All changes applied successfully.
206
Check what has changed::
210
If you're happy with the changes, you can commit them to your personal
213
$ bzr commit -m "Merge from main branch"
214
Committed revision 295.
217
Merging your work into the parent branch
218
========================================
220
After you've worked on your personal branch of bzr-gtk, you may want to
221
send your changes back upstream to the project. The easiest way is to
222
use a merge directive.
224
A merge directive is a machine-readable request to perform a
225
particular merge. It usually contains a patch preview of the merge
226
and either contains the necessary revisions, or provides a branch
227
where they can be found.
229
Replacing ``mycode.patch``, create your merge directive::
231
$ bzr send -o mycode.patch
232
Using saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
234
You can now email the merge directive to the bzr-gtk project who, if
235
they choose, can use it merge your work back into the parent branch.
241
You can find out more about Bazaar in the
242
`Bazaar User Guide <../user-guide/index.html>`_.
244
To learn about Bazaar on the command-line::
248
To learn about Bazaar commands::
252
To learn about the ''foo'' topic or command::
added
removed
doc/en/mini-tutorial/index.txt
