← 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: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

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 
 
15
If you'd prefer a more detailed introduction, take a look at
18
16
`Learning More`_.
19
17
 
20
18
 
46
44
Using your name and email address, instead of John Doe's, type::
47
45
 
48
46
  $ bzr whoami "John Doe <john.doe@gmail.com>"
49
 
  
 
47
 
50
48
Bazaar will now create or modify a configuration file, including your
51
49
name and email address.
52
50
 
65
63
 $ cd myproject
66
64
 $ mkdir subdirectory
67
65
 $ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
68
 
 
 
66
 
69
67
**Note for Windows users:** use Windows Explorer to create your
70
 
directories, then right-click in those directories and select 
 
68
directories, then right-click in those directories and select
71
69
``New file`` to create your files.
72
70
 
73
 
Now get Bazaar to initalize itself in your project directory::
 
71
Now get Bazaar to initialize itself in your project directory::
74
72
 
75
73
  $ bzr init
76
 
  
 
74
 
77
75
If it looks like nothing happened, don't worry. Bazaar has created a
78
76
branch_ where it will store your files and their revision histories.
79
77
 
89
87
 added test3.txt
90
88
 added subdirectory/test4.txt
91
89
 
92
 
Next, take a snapshot of your files by committing them to your branch. Add 
 
90
Next, take a snapshot of your files by committing them to your branch. Add
93
91
a message to explain why you made the commit::
94
92
 
95
93
  $ 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 
 
94
 
 
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
99
97
branch and all its commits inside the directory you're working with; look
100
98
for the ``.bzr`` sub-directory.
101
99
 
158
156
 
159
157
 $ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
160
158
 2 revision(s) pushed.
161
 
 
 
159
 
162
160
Bazaar will create a ``myproject`` directory on the remote server and
163
161
push your branch to it.
164
 
 
 
162
 
165
163
Now anyone can create their own copy of your branch by typing::
166
164
 
167
165
 $ bzr branch http://www.example.com/myproject
168
 
 
 
166
 
169
167
**Note:** to use sftp, you may need to install ``paramiko`` and
170
168
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
171
169
 
173
171
Publishing your branch with Launchpad
174
172
=====================================
175
173
 
176
 
Launchpad is a suite of development and hosting tools for free 
 
174
Launchpad is a suite of development and hosting tools for free
177
175
software projects. You can use it to publish your branch.
178
176
 
179
177
If you don't have a Launchpad account, follow the `account signup guide`_
182
180
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
183
181
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
184
182
 
185
 
Replacing ``john.doe`` with your own Launchpad username, type::
186
 
 
187
 
 $ bzr push bzr+ssh://john.doe@bazaar.launchpad.net/~john.doe/+junk/myproject
 
183
Replacing ``john.doe`` with your own Launchpad username, type [#]_::
 
184
 
 
185
 $ bzr push lp:~john.doe/+junk/myproject
 
186
 
 
187
.. [#] Use of the ``lp:`` URL scheme requires bzr 0.92 or later.
188
188
 
189
189
**Note:** ``+junk`` means that this branch isn't associated with any particular
190
190
project in Launchpad.
191
191
 
192
192
Now, anyone can create their own copy of your branch by typing::
193
193
 
194
 
 $ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject
195
 
 
 
194
 $ bzr branch lp:~john.doe/+junk/myproject
 
195
 
196
196
You can also see information about your branch, including its revision
197
197
history, at https://code.launchpad.net/people/+me/+junk/myproject
198
198
 
200
200
Creating your own copy of another branch
201
201
========================================
202
202
 
203
 
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
204
204
branch. Let's take a real-world example, Bazaar's GTK interface::
205
205
 
206
 
  $ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john
207
 
  Branched 292 revision(s).                                                        
 
206
  $ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
 
207
  Branched 292 revision(s).
208
208
 
209
209
Bazaar will download all the files and complete revision history from the
210
210
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
211
211
 
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 
 
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
215
215
makes it easy for them to merge your branch back into their trunk branch.
216
216
 
217
217
 
227
227
  $ bzr merge
228
228
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
229
229
  All changes applied successfully.
230
 
            
 
230
 
231
231
Check what has changed::
232
232
 
233
233
  $ bzr diff
234
 
 
 
234
 
235
235
If you're happy with the changes, you can commit them to your personal
236
236
branch::
237
237
 
246
246
send your changes back upstream to the project. The easiest way is to
247
247
use a merge directive.
248
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 
 
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
252
where they can be found.
253
253
 
254
254
Replacing ``mycode.patch``, create your merge directive::
255
255
 
256
256
 $ bzr send -o mycode.patch
257
257
 Using saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
258
 
 
 
258
 
259
259
You can now email the merge directive to the bzr-gtk project who, if
260
260
they choose, can use it merge your work back into the parent branch.
261
 
 
262
 
 
 
261
 
 
262
 
263
263
Learning more
264
264
=============
265
265