← 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: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/mini-tutorial/index.txt
1
 
======================
2
 
Bazaar in five minutes
3
 
======================
4
 
 
5
 
Introduction
6
 
============
7
 
 
8
 
Bazaar is a distributed version control system that makes it easier for
9
 
people to work together on software projects.
10
 
 
11
 
Over the next five minutes, you'll learn how to put your files under
12
 
version control, how to record changes to them, examine your work, publish
13
 
it and send your work for merger into a project's trunk.
14
 
 
15
 
If you'd prefer a more detailed introduction, take a look at
16
 
`Learning More`_.
17
 
 
18
 
 
19
 
Installation
20
 
============
21
 
 
22
 
This guide doesn't describe how to install Bazaar but it's usually very
23
 
easy. You can find installation instructions at:
24
 
 
25
 
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
26
 
- **Windows:** `installation instructions for Windows`_.
27
 
- **Mac OS X:** `installation instructions for Mac OS X`_.
28
 
 
29
 
For other platforms and to install from source code, see the Download_
30
 
and Installation_ pages.
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
36
 
 
37
 
 
38
 
Introducing yourself
39
 
====================
40
 
 
41
 
Before you start working, it is good to tell Bazaar who you are. That
42
 
way your work is properly identified in revision logs.
43
 
 
44
 
Using your name and email address, instead of John Doe's, type::
45
 
 
46
 
  $ bzr whoami "John Doe <john.doe@gmail.com>"
47
 
 
48
 
Bazaar will now create or modify a configuration file, including your
49
 
name and email address.
50
 
 
51
 
Now, check that your name and email address are correctly registered::
52
 
 
53
 
  $ bzr whoami
54
 
  John Doe <john.doe@gmail.com>
55
 
 
56
 
 
57
 
Putting files under version control
58
 
===================================
59
 
 
60
 
Let's create a directory and some files to use with Bazaar::
61
 
 
62
 
 $ mkdir myproject
63
 
 $ cd myproject
64
 
 $ mkdir subdirectory
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
69
 
``New file`` to create your files.
70
 
 
71
 
Now get Bazaar to initialize itself in your project directory::
72
 
 
73
 
  $ bzr init
74
 
 
75
 
If it looks like nothing happened, don't worry. Bazaar has created a
76
 
branch_ where it will store your files and their revision histories.
77
 
 
78
 
.. _branch: http://wiki.bazaar.canonical.com/Branch
79
 
 
80
 
The next step is to tell Bazaar which files you want to track. Running
81
 
``bzr add`` will recursively add everything in the project::
82
 
 
83
 
 $ bzr add
84
 
 added subdirectory
85
 
 added test1.txt
86
 
 added test2.txt
87
 
 added test3.txt
88
 
 added subdirectory/test4.txt
89
 
 
90
 
Next, take a snapshot of your files by committing them to your branch. Add
91
 
a message to explain why you made the commit::
92
 
 
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
97
 
branch and all its commits inside the directory you're working with; look
98
 
for the ``.bzr`` sub-directory.
99
 
 
100
 
 
101
 
Making changes to your files
102
 
============================
103
 
 
104
 
Let's change a file and commit that change to your branch.
105
 
 
106
 
Edit ``test1.txt`` in your favourite editor, then check what have you done::
107
 
 
108
 
 $ bzr diff
109
 
 === modified file 'test1.txt'
110
 
 --- test1.txt   2007-10-08 17:56:14 +0000
111
 
 +++ test1.txt   2007-10-08 17:46:22 +0000
112
 
 @@ -0,0 +1,1 @@
113
 
 +test test test
114
 
 
115
 
Commit your work to the Bazaar branch::
116
 
 
117
 
  $ bzr commit -m "Added first line of text"
118
 
  Committed revision 2.
119
 
 
120
 
 
121
 
Viewing the revision log
122
 
========================
123
 
 
124
 
You can see the history of your branch by browsing its log::
125
 
 
126
 
  $ bzr log
127
 
  ------------------------------------------------------------
128
 
  revno: 2
129
 
  committer: John Doe <john.doe@gmail.com>
130
 
  branch nick: myproject
131
 
  timestamp: Mon 2007-10-08 17:56:14 +0000
132
 
  message:
133
 
    Added first line of text
134
 
  ------------------------------------------------------------
135
 
  revno: 1
136
 
  committer: John Doe <john.doe@gmail.com>
137
 
  branch nick: myproject
138
 
  timestamp: Mon 2006-10-08 17:46:22 +0000
139
 
  message:
140
 
    Initial import
141
 
 
142
 
 
143
 
Publishing your branch with sftp
144
 
================================
145
 
 
146
 
There are a couple of ways to publish your branch. If you already have
147
 
an SFTP server or are comfortable setting one up, you can publish your
148
 
branch to it.
149
 
 
150
 
Otherwise, skip to the next section to publish with Launchpad_, a free
151
 
hosting service for Bazaar.
152
 
 
153
 
.. _Launchpad: https://launchpad.net/
154
 
 
155
 
Let's assume you want to publish your branch at ``www.example.com/myproject``::
156
 
 
157
 
 $ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
158
 
 2 revision(s) pushed.
159
 
 
160
 
Bazaar will create a ``myproject`` directory on the remote server and
161
 
push your branch to it.
162
 
 
163
 
Now anyone can create their own copy of your branch by typing::
164
 
 
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.
169
 
 
170
 
 
171
 
Publishing your branch with Launchpad
172
 
=====================================
173
 
 
174
 
Launchpad is a suite of development and hosting tools for free
175
 
software projects. You can use it to publish your branch.
176
 
 
177
 
If you don't have a Launchpad account, follow the `account signup guide`_
178
 
and `register an SSH key`_ in your new Launchpad account.
179
 
 
180
 
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
181
 
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
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
190
 
project in Launchpad.
191
 
 
192
 
Now, anyone can create their own copy of your branch by typing::
193
 
 
194
 
 $ bzr branch lp:~john.doe/+junk/myproject
195
 
 
196
 
You can also see information about your branch, including its revision
197
 
history, at https://code.launchpad.net/people/+me/+junk/myproject
198
 
 
199
 
 
200
 
Creating your own copy of another branch
201
 
========================================
202
 
 
203
 
To work with someone else's code, you can make your own copy of their
204
 
branch. Let's take a real-world example, Bazaar's GTK interface::
205
 
 
206
 
  $ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
207
 
  Branched 292 revision(s).
208
 
 
209
 
Bazaar will download all the files and complete revision history from the
210
 
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
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
215
 
makes it easy for them to merge your branch back into their trunk branch.
216
 
 
217
 
 
218
 
Updating your branch from the main branch
219
 
=========================================
220
 
 
221
 
While you commit changes to your branch, it's likely that other people will
222
 
also continue to commit code to the parent branch.
223
 
 
224
 
To make sure your branch stays up to date, you should merge changes from
225
 
the parent into your personal branch::
226
 
 
227
 
  $ bzr merge
228
 
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
229
 
  All changes applied successfully.
230
 
 
231
 
Check what has changed::
232
 
 
233
 
  $ bzr diff
234
 
 
235
 
If you're happy with the changes, you can commit them to your personal
236
 
branch::
237
 
 
238
 
  $ bzr commit -m "Merge from main branch"
239
 
  Committed revision 295.
240
 
 
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
 
 
263
 
Learning more
264
 
=============
265
 
 
266
 
You can find out more about Bazaar in the
267
 
`Bazaar User Guide <../user-guide/index.html>`_.
268
 
 
269
 
To learn about Bazaar on the command-line::
270
 
 
271
 
  $ bzr help
272
 
 
273
 
To learn about Bazaar commands::
274
 
 
275
 
  $ bzr help commands
276
 
 
277
 
To learn about the ''foo'' topic or command::
278
 
 
279
 
  $ bzr help foo