← 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: Jelmer Vernooij
  • Date: 2008-06-11 18:58:19 UTC
  • mto: (3649.3.2 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 3658.
  • Revision ID: jelmer@samba.org-20080611185819-o4shi1ranh9zh01e
Move ftp transport into separate directory.

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
 
15
 
If you'd prefer a more detailed introduction, take a look at
 
17
If you'd prefer a more detailed introduction, take a look at 
16
18
`Learning More`_.
17
19
 
18
20
 
29
31
For other platforms and to install from source code, see the Download_
30
32
and Installation_ pages.
31
33
 
32
 
.. _installation instructions for Windows: http://wiki.bazaar.canonical.com/WindowsDownloads
33
 
.. _installation instructions for Mac OS X: http://wiki.bazaar.canonical.com/MacOSXBundle
34
 
.. _Download: http://wiki.bazaar.canonical.com/Download
35
 
.. _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
36
38
 
37
39
 
38
40
Introducing yourself
44
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>"
47
 
 
 
49
  
48
50
Bazaar will now create or modify a configuration file, including your
49
51
name and email address.
50
52
 
63
65
 $ cd myproject
64
66
 $ mkdir subdirectory
65
67
 $ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
66
 
 
67
 
**Note for Windows users**: use Windows Explorer to create your
68
 
directories, then right-click in those directories and select
 
68
 
 
69
**Note for Windows users:** use Windows Explorer to create your
 
70
directories, then right-click in those directories and select 
69
71
``New file`` to create your files.
70
72
 
71
 
Now get Bazaar to initialize itself in your project directory::
 
73
Now get Bazaar to initalize itself in your project directory::
72
74
 
73
75
  $ bzr init
74
 
 
 
76
  
75
77
If it looks like nothing happened, don't worry. Bazaar has created a
76
78
branch_ where it will store your files and their revision histories.
77
79
 
78
 
.. _branch: http://wiki.bazaar.canonical.com/Branch
 
80
.. _branch: http://bazaar-vcs.org/Branch
79
81
 
80
82
The next step is to tell Bazaar which files you want to track. Running
81
83
``bzr add`` will recursively add everything in the project::
87
89
 added test3.txt
88
90
 added subdirectory/test4.txt
89
91
 
90
 
Next, take a snapshot of your files by committing them to your branch. Add
 
92
Next, take a snapshot of your files by committing them to your branch. Add 
91
93
a message to explain why you made the commit::
92
94
 
93
95
  $ 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
 
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 
97
99
branch and all its commits inside the directory you're working with; look
98
100
for the ``.bzr`` sub-directory.
99
101
 
156
158
 
157
159
 $ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
158
160
 2 revision(s) pushed.
159
 
 
 
161
 
160
162
Bazaar will create a ``myproject`` directory on the remote server and
161
163
push your branch to it.
162
 
 
 
164
 
163
165
Now anyone can create their own copy of your branch by typing::
164
166
 
165
167
 $ bzr branch http://www.example.com/myproject
166
 
 
167
 
**Note**: to use sftp, you may need to install ``paramiko`` and
168
 
``pyCrypto``. See http://wiki.bazaar.canonical.com/InstallationFaq for details.
 
168
 
 
169
**Note:** to use sftp, you may need to install ``paramiko`` and
 
170
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
169
171
 
170
172
 
171
173
Publishing your branch with Launchpad
172
174
=====================================
173
175
 
174
 
Launchpad is a suite of development and hosting tools for free
 
176
Launchpad is a suite of development and hosting tools for free 
175
177
software projects. You can use it to publish your branch.
176
178
 
177
179
If you don't have a Launchpad account, follow the `account signup guide`_
180
182
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
181
183
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
182
184
 
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
 
 
189
 
**Note**: ``+junk`` means that this branch isn't associated with any particular
 
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
 
188
 
 
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 lp:~john.doe/+junk/myproject
195
 
 
 
194
 $ bzr branch http://bazaar.launchpad.net/~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 lp:~bzr/bzr-gtk/trunk bzr-gtk.john
207
 
  Branched 292 revision(s).
 
206
  $ bzr branch http://bazaar.launchpad.net/~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
 
225
225
the parent into your personal branch::
226
226
 
227
227
  $ bzr merge
228
 
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
 
228
  Using saved 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
 
 Using saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
258
 
 
 
257
 Using saved location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
 
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