10
This is a very brief 5-minute tutorial, covering only what a first time user
11
needs to start a project or start contributing to a project using Bazaar.
12
For a more detailed look, see `Learning More`_.
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.
18
See http://bazaar-vcs.org/Download. Bazaar is probably in your GNU/Linux
19
distribution already. If not, it's trivial to install on any platform that
20
runs Python 2.4, including Windows. Installation should take at most a few
19
This guide doesn't describe how to install Bazaar but it's usually very
20
easy. You can find installation instructions at:
22
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
23
- **Windows:** `installation instructions for Windows`_.
24
- **Mac OS X:** `installation instructions for Mac OS X`_.
26
For other platforms and to install from source code, see the Download_
27
and Installation_ pages.
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
25
36
====================
27
You want Bazaar to correctly identify you in revision logs. Using your name
28
and email instead of Joe Doe's, type::
30
$ bzr whoami "Joe Doe <joe.doe@gmail.com>"
38
Bazaar 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 Bazaar who you are. Using your name
44
and email address, instead of John Doe's, type::
46
$ bzr whoami "John Doe <john.doe@gmail.com>"
48
You can check what identity is stored in Bazaar's configuration::
35
Joe Doe <joe.doe@gmail.com>
38
Putting Existing Files Under Version Control
39
============================================
41
It is very easy to put an existing set of files under version control using
47
$ bzr commit -m "Initial import"
49
You can now make changes, track them, publish your branch and so on as
53
Creating A Personal Branch
54
==========================
56
Rather than starting a new project, you may wish to work on an existing
57
project either you or someone else has published.
59
Create a branch of an existing project::
61
$ bzr branch http://example.com/code/foobar.dev foobar.joe
62
Branched 1 revision(s).
64
Note that after you create a personal branch, you don't need web access to
76
Check what have you done::
79
=== modified file 'foo.c'
88
_pyfribidi_log2vis (PyObject * self, PyObject * args, PyObject * kw)
91
Commit your hard work::
93
$ bzr commit -m 'added some whitespace'
97
Viewing the Revision Log
51
John Doe <john.doe@gmail.com>
54
Starting a new project
55
======================
57
Let's suppose we want to store a new project under Bazaar. 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
$ bzr init-repo sample
69
Shared repository with trees (format: 2a)
71
shared repository: sample
72
$ bzr 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 bzr we want it to
89
and then commit, which saves a snapshot of all versioned files::
91
bzr commit -m "Added first line of text"
94
Making changes to your files
95
============================
98
Let's change a file and commit that change to your branch.
100
Edit ``test1.txt`` in your favourite editor, then use ``bzr add`` to tell bzr
101
to track changes to this file ::
103
$ echo test test test > test1.txt
107
`bzr 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). ::
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
Committing to: /home/john/sample/trunk/
122
Committed revision 1.
124
Viewing the revision log
98
125
========================
100
Browse the history of the branch::
127
You can see the history of your branch by browsing its log::
103
------------------------------------------------------------
105
committer: Joe Doe <joe.doe@gmail.com>
106
branch nick: foobar.joe
107
timestamp: Mon 2006-02-06 01:33:35 +0200
109
added some whitespace
110
------------------------------------------------------------
112
committer: James Hacker <jmh@example.com>
113
branch nick: foobar.dev
114
timestamp: Mon 2006-02-06 01:06:11 +0200
131
committer: John Doe <john.doe@gmail.com>
133
timestamp: Mon 2006-10-08 17:46:22 +0000
119
Updating Your Branch from the Main Branch
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. Bazaar 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 now will let you more easily
165
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 Bazaar your Launchpad account name. If your account is john.doe, type ::
175
$ bzr 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
$ bzr 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
186
Creating your own copy of another branch
187
========================================
189
To work with someone else's code, you can make your own copy of their
190
branch. Let's take a real-world example, Bazaar's GTK interface::
192
$ bzr init-repo ~/bzr-gtk
193
$ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
194
Branched 292 revision(s).
196
Bazaar will download all the files and complete revision history from the
197
bzr-gtk project's trunk branch and create a copy called ``john``.
199
Now, you have your own copy of the branch and can commit changes with
200
or without a net connection. You can share your branch at any time by
201
publishing it and, if the bzr-gtk team want to use your work, Bazaar
202
makes it easy for them to merge your branch back into their trunk branch.
205
Updating your branch from the main branch
120
206
=========================================
122
While you work hard on your branch, others may have committed new code to the
123
main branch. From time to time, you want to merge changes from the main
124
branch into your branch::
208
While you commit changes to your branch, it's likely that other people will
209
also continue to commit code to the parent branch.
211
To make sure your branch stays up to date, you should merge changes from
212
the parent into your personal branch::
127
Using saved location: http://example.com/code/foobar.dev
215
Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
128
216
All changes applied successfully.
130
What was changed locally by merging the main branch?
218
Check what has changed::
135
=== modified file 'pyfribidi.c'
146
Commit the changes from the main branch::
148
$ bzr commit -m 'merge from main branch'
149
Committed revision 6.
151
Note that you may occasionally need to resolve conflicts or make other minor
152
changes (so tests pass say) before committing. For these reasons, merge does
153
not implicitly commit.
156
Publishing Your Branch
157
======================
159
You can simply use rsync to copy your branch to a web server, but using
160
``bzr push`` is the easiest way. Let's assume you want to publish your
161
branch in jod.example.com/foobar.joe and you have sftp access to the server::
163
$ bzr push sftp://jod@jod.example.com/public_html/foobar.joe/
164
2 revision(s) pushed.
166
Note that to use sftp, your may need to install ''paramiko'' and ''pyCrypto''.
167
See http://bazaar-vcs.org/InstallationFaq for details.
169
Now anyone can get your branch with (try it yourself!)::
171
bzr branch http://jod.example.com/foobar.joe/
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
Bazaar 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 ``bzr diff`` to check the
227
changes, and then ``bzr resolve`` to mark them as resolved.
229
If you're happy with the changes, you can commit them to your personal
232
$ bzr commit -m "Merge from main branch"
233
Committed revision 295.
177
To learn about bzr topics::
239
You can find out more about Bazaar in the
240
`Bazaar User Guide <../user-guide/index.html>`_.
242
To learn about Bazaar on the command-line::
181
To learn about bzr commands::
185
246
To learn about the ''foo'' topic or command::
189
Alternatively, browse the `Bazaar Documentation <../../index.html>`_.
253
Copyright 2007-2011 Canonical Ltd. Bazaar is free software, and you
254
may use, modify and redistribute both Bazaar 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
