← 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: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

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
 
29
29
For other platforms and to install from source code, see the Download_
30
30
and Installation_ pages.
31
31
 
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
 
32
.. _installation instructions for Windows: http://bazaar-vcs.org/WindowsDownloads
 
33
.. _installation instructions for Mac OS X: http://bazaar-vcs.org/MacOSXBundle
 
34
.. _Download: http://bazaar-vcs.org/Download
 
35
.. _Installation: http://bazaar-vcs.org/InstallationFaq
36
36
 
37
37
 
38
38
Introducing yourself
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
 
 
67
 
**Note for Windows users**: use Windows Explorer to create your
68
 
directories, then right-click in those directories and select
 
66
 
 
67
**Note for Windows users:** use Windows Explorer to create your
 
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
 
78
 
.. _branch: http://wiki.bazaar.canonical.com/Branch
 
78
.. _branch: http://bazaar-vcs.org/Branch
79
79
 
80
80
The next step is to tell Bazaar which files you want to track. Running
81
81
``bzr add`` will recursively add everything in the project::
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
 
 
167
 
**Note**: to use sftp, you may need to install ``paramiko`` and
168
 
``pyCrypto``. See http://wiki.bazaar.canonical.com/InstallationFaq for details.
 
166
 
 
167
**Note:** to use sftp, you may need to install ``paramiko`` and
 
168
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
169
169
 
170
170
 
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 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
 
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
 
186
 
 
187
**Note:** ``+junk`` means that this branch isn't associated with any particular
190
188
project in Launchpad.
191
189
 
192
190
Now, anyone can create their own copy of your branch by typing::
193
191
 
194
 
 $ bzr branch lp:~john.doe/+junk/myproject
195
 
 
 
192
 $ bzr branch http://bazaar.launchpad.net/~john.doe/+junk/myproject
 
193
 
196
194
You can also see information about your branch, including its revision
197
195
history, at https://code.launchpad.net/people/+me/+junk/myproject
198
196
 
200
198
Creating your own copy of another branch
201
199
========================================
202
200
 
203
 
To work with someone else's code, you can make your own copy of their
 
201
To work with someone else's code, you can make your own copy of their 
204
202
branch. Let's take a real-world example, Bazaar's GTK interface::
205
203
 
206
 
  $ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
207
 
  Branched 292 revision(s).
 
204
  $ bzr branch http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk bzr-gtk.john
 
205
  Branched 292 revision(s).                                                        
208
206
 
209
207
Bazaar will download all the files and complete revision history from the
210
208
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
211
209
 
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
 
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 
215
213
makes it easy for them to merge your branch back into their trunk branch.
216
214
 
217
215
 
227
225
  $ bzr merge
228
226
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
229
227
  All changes applied successfully.
230
 
 
 
228
            
231
229
Check what has changed::
232
230
 
233
231
  $ bzr diff
234
 
 
 
232
 
235
233
If you're happy with the changes, you can commit them to your personal
236
234
branch::
237
235
 
246
244
send your changes back upstream to the project. The easiest way is to
247
245
use a merge directive.
248
246
 
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
 
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 
252
250
where they can be found.
253
251
 
254
252
Replacing ``mycode.patch``, create your merge directive::
255
253
 
256
254
 $ bzr send -o mycode.patch
257
255
 Using saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
258
 
 
 
256
 
259
257
You can now email the merge directive to the bzr-gtk project who, if
260
258
they choose, can use it merge your work back into the parent branch.
261
 
 
262
 
 
 
259
 
 
260
 
263
261
Learning more
264
262
=============
265
263