← 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 Pool
  • Date: 2010-01-12 06:30:41 UTC
  • mfrom: (4634.119.3 2.0)
  • mto: This revision was merged to the branch mainline in revision 4951.
  • Revision ID: mbp@sourcefrog.net-20100112063041-qp2ei0clx5gh0e9e
merge 2.0 back to trunk

Show diffs side-by-side

added added

removed removed

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