1
1
======================
3
3
======================
8
Bazaar is a distributed version control system that makes it easier for
8
Breezy is a distributed version control system that makes it easier for
9
9
people to work together on software projects.
11
11
Over the next five minutes, you'll learn how to put your files under
12
12
version control, how to record changes to them, examine your work, publish
13
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
19
This guide doesn't describe how to install Breezy but it's usually very
23
20
easy. You can find installation instructions at:
25
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
22
- **GNU/Linux:** Breezy is probably in your GNU/Linux distribution already.
26
23
- **Windows:** `installation instructions for Windows`_.
27
24
- **Mac OS X:** `installation instructions for Mac OS X`_.
29
26
For other platforms and to install from source code, see the Download_
30
27
and Installation_ pages.
32
.. _installation instructions for Windows: http://bazaar-vcs.org/WindowsDownloads
33
.. _installation instructions for Mac OS X: http://bazaar-vcs.org/MacOSXBundle
34
.. _Download: http://bazaar-vcs.org/Download
35
.. _Installation: http://bazaar-vcs.org/InstallationFaq
29
.. _installation instructions for Windows: http://wiki.bazaar.canonical.com/WindowsDownloads
30
.. _installation instructions for Mac OS X: http://wiki.bazaar.canonical.com/MacOSXBundle
31
.. _Download: http://wiki.bazaar.canonical.com/Download
32
.. _Installation: http://wiki.bazaar.canonical.com/InstallationFaq
38
35
Introducing yourself
39
36
====================
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::
38
Breezy records changes to source code, and it records who made the change.
39
The person is identified by their name and email address. (If you're
40
concerned about spam, you don't need to use a real address that you
41
actually read, but the convention is that it looks like an email address.)
43
Before you start working, let's tell Breezy who you are. Using your name
44
and email address, instead of John Doe's, type::
46
$ brz whoami "John Doe <john.doe@gmail.com>"
48
You can check what identity is stored in Breezy's configuration::
54
51
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://bazaar-vcs.org/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.
54
Starting a new project
55
======================
57
Let's suppose we want to store a new project under Breezy. First, we'll
58
make a *repository directory* to hold all our work related to this
59
project, where developers can create branches to test development of
60
specific features or, more generally, modifications to the working file
63
After creating the repository, change to that directory, and create the
64
project's main trunk branch.
68
$ brz init-repo sample
69
Shared repository with trees (format: 2a)
71
shared repository: sample
72
$ brz init sample/trunk
74
Created a repository tree (format: 2a)
75
Using shared repository: /home/john/sample/
81
Now that we have the trunk, we need to move to that directory and
82
create some example files for the first version of that project. Create
83
a file ``test1.txt`` using a text editor (like emacs, nano, or notepad),
84
and save it. Then we'll "add" the file, which tells brz we want it to
89
and then commit, which saves a snapshot of all versioned files::
91
brz commit -m "Added first line of text"
101
94
Making changes to your files
102
95
============================
104
98
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::
100
Edit ``test1.txt`` in your favourite editor, then use ``brz add`` to tell brz
101
to track changes to this file ::
103
$ echo test test test > test1.txt
107
`brz diff` shows the changes between the last revision in this branch, and your
108
current tree (or, with the ``-r`` option, between any two trees). ::
109
111
=== modified file 'test1.txt'
110
112
--- test1.txt 2007-10-08 17:56:14 +0000
111
113
+++ 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.
117
Commit your work to the Breezy branch::
119
$ brz commit -m "Added first line of text"
120
Committing to: /home/john/sample/trunk/
122
Committed revision 1.
121
124
Viewing the revision log
122
125
========================
124
127
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
131
committer: John Doe <john.doe@gmail.com>
137
branch nick: myproject
138
133
timestamp: Mon 2006-10-08 17:46:22 +0000
143
Publishing your branch with sftp
144
================================
146
There are a couple of ways to publish your branch. If you already have
147
an SFTP server or are comfortable setting one up, you can publish your
150
Otherwise, skip to the next section to publish with Launchpad_, a free
151
hosting service for Bazaar.
153
.. _Launchpad: https://launchpad.net/
155
Let's assume you want to publish your branch at ``www.example.com/myproject``::
157
$ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
158
2 revision(s) pushed.
160
Bazaar will create a ``myproject`` directory on the remote server and
161
push your branch to it.
163
Now anyone can create their own copy of your branch by typing::
165
$ bzr branch http://www.example.com/myproject
167
**Note:** to use sftp, you may need to install ``paramiko`` and
168
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
171
Publishing your branch with Launchpad
172
=====================================
174
Launchpad is a suite of development and hosting tools for free
175
software projects. You can use it to publish your branch.
177
If you don't have a Launchpad account, follow the `account signup guide`_
178
and `register an SSH key`_ in your new Launchpad account.
180
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
181
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
183
Replacing ``john.doe`` with your own Launchpad username, type [#]_::
185
$ bzr push lp:~john.doe/+junk/myproject
187
.. [#] Use of the ``lp:`` URL scheme requires bzr 0.92 or later.
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 lp:~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
138
Publishing your branch on Launchpad
139
===================================
141
Launchpad is a suite of development and hosting tools for
142
software projects. You can use it to publish your branch. (You can
143
also publish branches onto your own server or other hosting services.)
145
The steps to publishing branches on Launchpad are:
147
1. Create a Launchpad account: visit the `Launchpad login page`_ and choose to create a new account.
149
.. _Launchpad login page: https://launchpad.net/+login
151
2. Breezy uses the SSH encryption and authentication protocol to connect
152
to Launchpad. You need to first `create an SSH key`_ on your own computer,
153
by running the command::
157
.. _create an SSH key: https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair
159
3. `Upload your SSH public key to Launchpad`_.
161
.. _Upload your SSH public key to Launchpad: https://launchpad.net/~/+editsshkeys
163
4. `Make a team for your project`_. Even if you're starting as the only
164
developer on this project, creating a new one now will let you more
165
easily add other people later.
167
.. _Make a team for your project: https://help.launchpad.net/Teams/CreatingAndRunning
169
5. `Create a project`_.
171
.. _Create a project: https://help.launchpad.net/Projects/Registering
173
6. Tell Breezy your Launchpad account name. If your account is john.doe, type ::
175
$ brz launchpad-login john.doe
177
7. `Push the branch for your project`_. Once you've committed your changes
178
locally, you can publish them as the trunk of your new project by saying
180
$ brz push lp:~sample-developers/sample/trunk
182
(Of course, using the team and project names you just chose.)
184
.. _Push the branch for your project: https://help.launchpad.net/Code/UploadingABranch
200
186
Creating your own copy of another branch
201
187
========================================
203
189
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::
190
branch. Let's take a real-world example, Breezy's GTK interface::
206
$ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
192
$ brz init-repo ~/brz-gtk
193
$ brz branch lp:~brz/brz-gtk/trunk ~/brz-gtk/john
207
194
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.
196
Breezy will download all the files and complete revision history from the
197
brz-gtk project's trunk branch and create a copy called ``john``.
212
199
Now, you have your own copy of the branch and can commit changes with
213
200
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
201
publishing it and, if the brz-gtk team want to use your work, Breezy
215
202
makes it easy for them to merge your branch back into their trunk branch.
224
211
To make sure your branch stays up to date, you should merge changes from
225
212
the parent into your personal branch::
228
Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
215
Merging from saved parent location: http://bazaar.launchpad.net/~brz/brz-gtk/trunk
229
216
All changes applied successfully.
231
218
Check what has changed::
222
If different branches have made changes to the same areas of the same
223
files, then merging them may generate conflicts. When this happens,
224
Breezy puts text markers like ``<<<<<<<`` into the files, and records them
225
in a list of conflicted files. You should edit the files to reflect the
226
way you want to resolve the conflicts, use ``brz diff`` to check the
227
changes, and then ``brz resolve`` to mark them as resolved.
235
229
If you're happy with the changes, you can commit them to your personal
238
$ bzr commit -m "Merge from main branch"
232
$ brz commit -m "Merge from main branch"
239
233
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 parent 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
267
`Bazaar User Guide <../user-guide/index.html>`_.
269
To learn about Bazaar on the command-line::
273
To learn about Bazaar commands::
239
You can find out more about Breezy in the
240
`Breezy User Guide <../user-guide/index.html>`_.
242
To learn about Breezy on the command-line::
277
246
To learn about the ''foo'' topic or command::
253
Copyright 2007-2011 Canonical Ltd. Breezy is free software, and you
254
may use, modify and redistribute both Breezy and this document under
255
the terms of the GNU General Public License version 2 or later. See
256
<http://www.gnu.org/licenses/>.
added
removed
doc/en/mini-tutorial/index.txt
