35
38
Introducing yourself
36
39
====================
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.)
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.
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::
44
Using your name and email address, instead of John Doe's, type::
46
46
$ bzr whoami "John Doe <john.doe@gmail.com>"
48
You can check what identity is stored in Bazaar's configuration::
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::
51
54
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.
77
Now that we have the trunk, we need to move to that directory and
78
create some example files for the first version of that project. Create
79
a file ``test1.txt`` using a text editor (like emacs, nano, or notepad),
80
and save it. Then we'll "add" the file, which tells bzr we want it to
85
and then commit, which saves a snapshot of all versioned files::
87
bzr commit -m "Added first line of text"
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.
90
101
Making changes to your files
91
102
============================
94
104
Let's change a file and commit that change to your branch.
96
106
Edit ``test1.txt`` in your favourite editor, then check what have you done::
133
Publishing your branch on Launchpad
134
===================================
136
Launchpad is a suite of development and hosting tools for
137
software projects. You can use it to publish your branch. (You can
138
also publish branches onto your own server or other hosting services.)
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://wiki.bazaar.canonical.com/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.
140
177
If you don't have a Launchpad account, follow the `account signup guide`_
141
178
and `register an SSH key`_ in your new Launchpad account.
143
180
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
144
181
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
146
Replacing ``john.doe`` with your own Launchpad username, type::
183
Replacing ``john.doe`` with your own Launchpad username, type [#]_::
148
185
$ bzr push lp:~john.doe/+junk/myproject
150
**Note**: ``+junk`` is a place to store experimental branches not
151
associated with any particular project. Normally, you should push a
152
project into an existing project, or register a new project through the
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.
155
192
Now, anyone can create their own copy of your branch by typing::
166
203
To work with someone else's code, you can make your own copy of their
167
204
branch. Let's take a real-world example, Bazaar's GTK interface::
169
$ bzr init-repo ~/bzr-gtk
170
$ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
206
$ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
171
207
Branched 292 revision(s).
173
209
Bazaar will download all the files and complete revision history from the
174
bzr-gtk project's trunk branch and create a copy called ``john``.
210
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
176
212
Now, you have your own copy of the branch and can commit changes with
177
213
or without a net connection. You can share your branch at any time by
199
If different branches have made changes to the same areas of the same
200
files, then merging them may generate conflicts. When this happens,
201
Bazaar puts text markers like ``<<<<<<<`` into the files, and records them
202
in a list of conflicted files. You should edit the files to reflect the
203
way you want to resolve the conflicts, use ``bzr diff`` to check the
204
changes, and then ``bzr resolve`` to mark them as resolved.
206
235
If you're happy with the changes, you can commit them to your personal
210
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 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.
added
removed
doc/en/mini-tutorial/index.txt
