← 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

  • Committer: Matt Nordhoff
  • Date: 2009-06-23 22:31:59 UTC
  • mto: This revision was merged to the branch mainline in revision 4479.
  • Revision ID: mnordhoff@mattnordhoff.com-20090623223159-fqfgl9c7a4umtafj
bzrlib.util.bencode's deprecation warning used the wrong stacklevel

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
 
5
7
Introduction
6
8
============
7
9
 
8
10
Bazaar is a distributed version control system that makes it easier for
9
 
people to work together on software projects.
 
11
people to work together on software projects. 
10
12
 
11
13
Over the next five minutes, you'll learn how to put your files under
12
14
version control, how to record changes to them, examine your work, publish
13
15
it and send your work for merger into a project's trunk.
14
16
 
 
17
If you'd prefer a more detailed introduction, take a look at 
 
18
`Learning More`_.
 
19
 
15
20
 
16
21
Installation
17
22
============
26
31
For other platforms and to install from source code, see the Download_
27
32
and Installation_ pages.
28
33
 
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
 
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
33
38
 
34
39
 
35
40
Introducing yourself
36
41
====================
37
42
 
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, it is good to tell Bazaar who you are. That
 
44
way your work is properly identified in revision logs.
42
45
 
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
Using your name and email address, instead of John Doe's, type::
45
47
 
46
48
  $ 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.
47
52
 
48
 
You can check what identity is stored in Bazaar's configuration::
 
53
Now, check that your name and email address are correctly registered::
49
54
 
50
55
  $ bzr whoami
51
56
  John Doe <john.doe@gmail.com>
52
57
 
53
58
 
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.  We can then have multiple branch directories under here, and
60
 
they'll all store the committed history in the repository.
61
 
 
62
 
::
63
 
 
64
 
  bzr init-repo sample
65
 
  cd sample
66
 
  bzr init trunk
67
 
  cd trunk
 
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 initialize 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.
68
101
 
69
102
 
70
103
Making changes to your files
109
142
    Initial import
110
143
 
111
144
 
112
 
Publishing your branch on Launchpad
113
 
===================================
114
 
 
115
 
Launchpad is a suite of development and hosting tools for
116
 
software projects. You can use it to publish your branch.  (You can 
117
 
also publish branches onto your own server or other hosting services.)
 
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.
118
178
 
119
179
If you don't have a Launchpad account, follow the `account signup guide`_
120
180
and `register an SSH key`_ in your new Launchpad account.
124
184
 
125
185
Replacing ``john.doe`` with your own Launchpad username, type::
126
186
 
127
 
 $ bzr push lp:~john.doe/+junk/myproject
 
187
 $ bzr push bzr+ssh://john.doe@bazaar.launchpad.net/~john.doe/+junk/myproject
128
188
 
129
 
**Note**: ``+junk`` is a place to store experimental branches not
130
 
associated with any particular project.  Normally, you should push a
131
 
project into an existing project, or register a new project through the
132
 
web interface.
 
189
**Note:** ``+junk`` means that this branch isn't associated with any particular
 
190
project in Launchpad.
133
191
 
134
192
Now, anyone can create their own copy of your branch by typing::
135
193
 
136
 
 $ bzr branch lp:~john.doe/+junk/myproject
137
 
 
 
194
 $ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject
 
195
 
138
196
You can also see information about your branch, including its revision
139
197
history, at https://code.launchpad.net/people/+me/+junk/myproject
140
198
 
142
200
Creating your own copy of another branch
143
201
========================================
144
202
 
145
 
To work with someone else's code, you can make your own copy of their
 
203
To work with someone else's code, you can make your own copy of their 
146
204
branch. Let's take a real-world example, Bazaar's GTK interface::
147
205
 
148
 
  $ bzr init-repo ~/bzr-gtk
149
 
  $ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
150
 
  Branched 292 revision(s).
 
206
  $ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john
 
207
  Branched 292 revision(s).                                                        
151
208
 
152
209
Bazaar will download all the files and complete revision history from the
153
 
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.
154
211
 
155
 
Now, you have your own copy of the branch and can commit changes with
156
 
or without a net connection. You can share your branch at any time by
157
 
publishing it and, if the  bzr-gtk team want to use your work, Bazaar
 
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 
158
215
makes it easy for them to merge your branch back into their trunk branch.
159
216
 
160
217
 
170
227
  $ bzr merge
171
228
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
172
229
  All changes applied successfully.
173
 
 
 
230
            
174
231
Check what has changed::
175
232
 
176
233
  $ bzr diff
177
 
 
178
 
If different branches have made changes to the same areas of the same
179
 
files, then merging them may generate conflicts.  When this happens,
180
 
Bazaar puts text markers like ``<<<<<<<`` into the files, and records them
181
 
in a list of conflicted files.  You should edit the files to reflect the
182
 
way you want to resolve the conflicts, use ``bzr diff`` to check the
183
 
changes, and then ``bzr resolve`` to mark them as resolved.
184
 
 
 
234
 
185
235
If you're happy with the changes, you can commit them to your personal
186
236
branch::
187
237
 
189
239
  Committed revision 295.
190
240
 
191
241
 
 
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 parent 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
 
192
263
Learning more
193
264
=============
194
265
 
199
270
 
200
271
  $ bzr help
201
272
 
 
273
To learn about Bazaar commands::
 
274
 
 
275
  $ bzr help commands
 
276
 
202
277
To learn about the ''foo'' topic or command::
203
278
 
204
279
  $ bzr help foo
205
 
 
206
 
Licence
207
 
=======
208
 
 
209
 
Copyright 2007-2011 Canonical Ltd. Bazaar is free software, and you
210
 
may use, modify and redistribute both Bazaar and this document under
211
 
the terms of the GNU General Public License version 2 or later. See
212
 
<http://www.gnu.org/licenses/>.