← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/mini-tutorial/index.txt

(jelmer) Support upgrading between the 2a and development-colo formats.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/mini-tutorial/index.txt
2
2
Bazaar in five minutes
3
3
======================
4
4
 
5
 
.. contents::
6
 
 
7
5
Introduction
8
6
============
9
7
 
10
8
Bazaar is a distributed version control system that makes it easier for
11
 
people to work together on software projects. 
 
9
people to work together on software projects.
12
10
 
13
11
Over the next five minutes, you'll learn how to put your files under
14
12
version control, how to record changes to them, examine your work, publish
15
13
it and send your work for merger into a project's trunk.
16
14
 
17
 
If you'd prefer a more detailed introduction, take a look at 
18
 
`Learning More`_.
19
 
 
20
15
 
21
16
Installation
22
17
============
31
26
For other platforms and to install from source code, see the Download_
32
27
and Installation_ pages.
33
28
 
34
 
.. _installation instructions for Windows: http://bazaar-vcs.org/WindowsDownloads
35
 
.. _installation instructions for Mac OS X: http://bazaar-vcs.org/MacOSXBundle
36
 
.. _Download: http://bazaar-vcs.org/Download
37
 
.. _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
33
 
39
34
 
40
35
Introducing yourself
41
36
====================
42
37
 
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.
 
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.)
45
42
 
46
 
Using your name and email address, instead of John Doe's, type::
 
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::
47
45
 
48
46
  $ bzr whoami "John Doe <john.doe@gmail.com>"
49
 
  
50
 
Bazaar will now create or modify a configuration file, including your
51
 
name and email address.
52
47
 
53
 
Now, check that your name and email address are correctly registered::
 
48
You can check what identity is stored in Bazaar's configuration::
54
49
 
55
50
  $ bzr whoami
56
51
  John Doe <john.doe@gmail.com>
57
52
 
58
53
 
59
 
Putting files under version control
60
 
===================================
61
 
 
62
 
Let's create a directory and some files to use with Bazaar::
63
 
 
64
 
 $ mkdir myproject
65
 
 $ cd myproject
66
 
 $ mkdir subdirectory
67
 
 $ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
68
 
 
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.
72
 
 
73
 
Now get Bazaar to initalize itself in your project directory::
74
 
 
75
 
  $ bzr init
76
 
  
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.
79
 
 
80
 
.. _branch: http://bazaar-vcs.org/Branch
81
 
 
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::
84
 
 
85
 
 $ bzr add
86
 
 added subdirectory
87
 
 added test1.txt
88
 
 added test2.txt
89
 
 added test3.txt
90
 
 added subdirectory/test4.txt
91
 
 
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::
94
 
 
95
 
  $ bzr commit -m "Initial import"
96
 
  
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.
 
54
Starting a new project
 
55
======================
 
56
 
 
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
 
61
set.  
 
62
 
 
63
After creating the repository, change to that directory, and create the
 
64
project's main trunk branch.
 
65
 
 
66
::
 
67
 
 
68
  bzr init-repo sample
 
69
  cd sample
 
70
  bzr init trunk
 
71
  cd trunk
 
72
 
 
73
 
 
74
Adding files
 
75
============
 
76
 
 
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
 
81
track changes::
 
82
 
 
83
  bzr add test1.txt
 
84
 
 
85
and then commit, which saves a snapshot of all versioned files::
 
86
 
 
87
  bzr commit -m "Added first line of text"
101
88
 
102
89
 
103
90
Making changes to your files
104
91
============================
105
92
 
 
93
 
106
94
Let's change a file and commit that change to your branch.
107
95
 
108
96
Edit ``test1.txt`` in your favourite editor, then check what have you done::
142
130
    Initial import
143
131
 
144
132
 
145
 
Publishing your branch with sftp
146
 
================================
147
 
 
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
150
 
branch to it.
151
 
 
152
 
Otherwise, skip to the next section to publish with Launchpad_, a free
153
 
hosting service for Bazaar.
154
 
 
155
 
.. _Launchpad: https://launchpad.net/
156
 
 
157
 
Let's assume you want to publish your branch at ``www.example.com/myproject``::
158
 
 
159
 
 $ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
160
 
 2 revision(s) pushed.
161
 
 
162
 
Bazaar will create a ``myproject`` directory on the remote server and
163
 
push your branch to it.
164
 
 
165
 
Now anyone can create their own copy of your branch by typing::
166
 
 
167
 
 $ bzr branch http://www.example.com/myproject
168
 
 
169
 
**Note:** to use sftp, you may need to install ``paramiko`` and
170
 
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
171
 
 
172
 
 
173
 
Publishing your branch with Launchpad
174
 
=====================================
175
 
 
176
 
Launchpad is a suite of development and hosting tools for free 
177
 
software projects. You can use it to publish your branch.
 
133
Publishing your branch on Launchpad
 
134
===================================
 
135
 
 
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.)
178
139
 
179
140
If you don't have a Launchpad account, follow the `account signup guide`_
180
141
and `register an SSH key`_ in your new Launchpad account.
184
145
 
185
146
Replacing ``john.doe`` with your own Launchpad username, type::
186
147
 
187
 
 $ bzr push bzr+ssh://john.doe@bazaar.launchpad.net/~john.doe/+junk/myproject
 
148
 $ bzr push lp:~john.doe/+junk/myproject
188
149
 
189
 
**Note:** ``+junk`` means that this branch isn't associated with any particular
190
 
project in Launchpad.
 
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
 
153
web interface.
191
154
 
192
155
Now, anyone can create their own copy of your branch by typing::
193
156
 
194
 
 $ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject
195
 
 
 
157
 $ bzr branch lp:~john.doe/+junk/myproject
 
158
 
196
159
You can also see information about your branch, including its revision
197
160
history, at https://code.launchpad.net/people/+me/+junk/myproject
198
161
 
200
163
Creating your own copy of another branch
201
164
========================================
202
165
 
203
 
To work with someone else's code, you can make your own copy of their 
 
166
To work with someone else's code, you can make your own copy of their
204
167
branch. Let's take a real-world example, Bazaar's GTK interface::
205
168
 
206
 
  $ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john
207
 
  Branched 292 revision(s).                                                        
 
169
  $ bzr init-repo ~/bzr-gtk
 
170
  $ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
 
171
  Branched 292 revision(s).
208
172
 
209
173
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.
 
174
bzr-gtk project's trunk branch and create a copy called ``john``.
211
175
 
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 
 
176
Now, you have your own copy of the branch and can commit changes with
 
177
or without a net connection. You can share your branch at any time by
 
178
publishing it and, if the  bzr-gtk team want to use your work, Bazaar
215
179
makes it easy for them to merge your branch back into their trunk branch.
216
180
 
217
181
 
225
189
the parent into your personal branch::
226
190
 
227
191
  $ bzr merge
228
 
  Using saved location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
 
192
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
229
193
  All changes applied successfully.
230
 
            
 
194
 
231
195
Check what has changed::
232
196
 
233
197
  $ bzr diff
234
 
 
 
198
 
 
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.
 
205
 
235
206
If you're happy with the changes, you can commit them to your personal
236
207
branch::
237
208
 
239
210
  Committed revision 295.
240
211
 
241
212
 
242
 
Merging your work into the parent branch
243
 
========================================
244
 
 
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.
248
 
 
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.
253
 
 
254
 
Replacing ``mycode.patch``, create your merge directive::
255
 
 
256
 
 $ bzr send -o mycode.patch
257
 
 Using saved location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
258
 
 
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.
261
 
 
262
 
 
263
213
Learning more
264
214
=============
265
215
 
270
220
 
271
221
  $ bzr help
272
222
 
273
 
To learn about Bazaar commands::
274
 
 
275
 
  $ bzr help commands
276
 
 
277
223
To learn about the ''foo'' topic or command::
278
224
 
279
225
  $ bzr help foo
 
226
 
 
227
Licence
 
228
=======
 
229
 
 
230
Copyright 2007-2011 Canonical Ltd. Bazaar is free software, and you
 
231
may use, modify and redistribute both Bazaar and this document under
 
232
the terms of the GNU General Public License version 2 or later. See
 
233
<http://www.gnu.org/licenses/>.