« back to all changes in this revision
Viewing changes to doc/en/mini-tutorial/index.txt
- browse files at revision 2900.2.17
- compare with another revision
- download diff
- download tarball
- view history from revision 2900.2.17
- Committer: Vincent Ladeuil
- Date: 2007-10-23 07:15:13 UTC
- mfrom: (2926 +trunk)
- mto: (2961.1.1 trunk)
- mto: This revision was merged to the branch mainline in revision 2962.
- Revision ID: v.ladeuil+lp@free.fr-20071023071513-elryt6g2at34d2ur
merge bzr.dev
- files modified:
- Makefile
added
removed
doc/en/mini-tutorial/index.txt
1
====================
2
Bazaar Mini Tutorial
3
====================
1
===================
2
Bazaar in five minutes
3
===================
4
4
5
5
.. contents::
6
6
7
7
Introduction
8
8
============
9
9
10
This is a very brief 5-minute tutorial, covering only what a first time user
11
needs to start a project or start contributing to a project using Bazaar.
12
For a more detailed look, see `Learning More`_.
10
Bazaar is a distributed version control system that makes it easier for
11
people to work together on software projects.
12
13
Over the next five minutes, you'll learn how to put your files under
14
version control, how to record changes to them, examine your work, publish
15
it and send your work for merger into a project's trunk.
16
17
If you'd prefer a more detailed introduction, take a look at
18
`Learning More`_.
13
19
14
20
15
21
Installation
16
22
============
17
23
18
See http://bazaar-vcs.org/Download. Bazaar is probably in your GNU/Linux
19
distribution already. If not, it's trivial to install on any platform that
20
runs Python 2.4, including Windows. Installation should take at most a few
21
minutes.
22
23
24
Introducing Yourself
24
This guide doesn't describe how to install Bazaar but it's usually very
25
easy. You can find installation instructions at:
26
27
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
28
- **Windows:** `installation instructions`_.
29
- **Mac OS X:** `install using MacPorts`_.
30
31
For other platforms and to install from source code, see the Downloads_
32
and Installation_ pages.
33
34
.. _installation instructions: http://bazaar-vcs.org/WindowsDownloads
35
.. _install using MacPorts: http://bazaar-vcs.org/MacPorts
36
.. _Downloads: http://bazaar-vcs.org/Download
37
.. _Installation: http://bazaar-vcs.org/InstallationFAQ
38
39
40
Introducing yourself
25
41
====================
26
42
27
You want Bazaar to correctly identify you in revision logs. Using your name
28
and email instead of Joe Doe's, type::
29
30
$ bzr whoami "Joe Doe <joe.doe@gmail.com>"
31
32
Now try::
43
Before you start working, it is good to tell Bazaar who you are. That
44
way your work is properly identified in revision logs.
45
46
Using your name and email address, instead of John Doe's, type::
47
48
$ bzr whoami "John Doe <john.doe@gmail.com>"
49
50
Bazaar will now create or modify a configuration file, including your
51
name and email address.
52
53
Now, check that your name and email address are correctly registered::
33
54
34
55
$ bzr whoami
35
Joe Doe <joe.doe@gmail.com>
36
37
38
Putting Existing Files Under Version Control
39
============================================
40
41
It is very easy to put an existing set of files under version control using
42
Bazaar::
43
44
$ cd my-project
45
$ bzr init .
46
$ bzr add
56
John Doe <john.doe@gmail.com>
57
58
59
Putting files under version control
60
===================================
61
62
Let's create a directory and some files to use with Bazaar::
63
64
$ mkdir myproject
65
$ cd myproject
66
$ mkdir subdirectory
67
$ touch test1.txt test2.txt test3.txt subdirectory/test4.txt
68
69
**Note for Windows users:** use Windows Explorer to create your
70
directories, then right-click in those directories and select
71
``New file`` to create your files.
72
73
Now get Bazaar to initalize itself in your project directory::
74
75
$ bzr init
76
77
If it looks like nothing happened, don't worry. Bazaar has created a
78
branch_ where it will store your files and their revision histories.
79
80
.. _branch: http://bazaar-vcs.org/Branch
81
82
The next step is to tell Bazaar which files you want to track. Running
83
``bzr add`` will recursively add everything in the project::
84
85
$ bzr add
86
added subdirectory
87
added test1.txt
88
added test2.txt
89
added test3.txt
90
added subdirectory/test4.txt
91
92
Next, take a snapshot of your files by committing them to your branch. Add
93
a message to explain why you made the commit::
94
47
95
$ bzr commit -m "Initial import"
48
49
You can now make changes, track them, publish your branch and so on as
50
explained below.
51
52
53
Creating A Personal Branch
54
==========================
55
56
Rather than starting a new project, you may wish to work on an existing
57
project either you or someone else has published.
58
59
Create a branch of an existing project::
60
61
$ bzr branch http://example.com/code/foobar.dev foobar.joe
62
Branched 1 revision(s).
63
64
Note that after you create a personal branch, you don't need web access to
65
commit changes.
66
67
68
Making Changes
69
==============
70
71
Edit a file::
72
73
$ cd foobar.joe
74
$ hack...
75
76
Check what have you done::
77
78
$ bzr diff
79
=== modified file 'foo.c'
80
--- foo.c
81
+++ foo.c
82
@@ -30,6 +30,7 @@
83
84
#include "foo.h"
85
86
+
87
static PyObject *
88
_pyfribidi_log2vis (PyObject * self, PyObject * args, PyObject * kw)
89
{
90
91
Commit your hard work::
92
93
$ bzr commit -m 'added some whitespace'
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
99
branch and all its commits inside the directory you're working with; look
100
for the ``.bzr`` sub-directory.
101
102
103
Making changes to your files
104
============================
105
106
Let's change a file and commit those changes to your branch.
107
108
Edit ``test1.txt`` in your favourite editor, then check what have you done::
109
110
$ bzr diff
111
=== modified file 'test1.txt'
112
--- test1.txt 2007-10-08 17:56:14 +0000
113
+++ test1.txt 2007-10-08 17:46:22 +0000
114
@@ -0,0 +1,1 @@
115
+test test test
116
117
Commit your work to the Bazaar branch::
118
119
$ bzr commit -m 'Added first line of text'
94
120
Committed revision 2.
95
121
96
122
97
Viewing the Revision Log
123
Viewing the revision log
98
124
========================
99
125
100
Browse the history of the branch::
126
You can see the history of your branch by browsing its log::
101
127
102
128
$ bzr log
103
129
------------------------------------------------------------
104
130
revno: 2
105
committer: Joe Doe <joe.doe@gmail.com>
106
branch nick: foobar.joe
107
timestamp: Mon 2006-02-06 01:33:35 +0200
131
committer: John Doe <john.doe@gmail.com>
132
branch nick: myproject
133
timestamp: Mon 2007-10-08 17:56:14 +0000
108
134
message:
109
added some whitespace
135
Added first line of text
110
136
------------------------------------------------------------
111
137
revno: 1
112
committer: James Hacker <jmh@example.com>
113
branch nick: foobar.dev
114
timestamp: Mon 2006-02-06 01:06:11 +0200
138
committer: John Doe <john.doe@gmail.com>
139
branch nick: myproject
140
timestamp: Mon 2006-10-08 17:46:22 +0000
115
141
message:
116
initial revision
117
118
119
Updating Your Branch from the Main Branch
142
Initial import
143
144
145
Publishing your branch with sftp
146
================================
147
148
There are a couple of ways to publish your branch. If you already have
149
an SFTP server or are comfortable setting one up, you can publish your
150
branch to it.
151
152
Otherwise, skip to the next section to publish with Launchpad_, a free
153
hosting service for Bazaar.
154
155
.. _Launchpad: https://launchpad.net/
156
157
Let's assume you want to publish your branch at ``www.example.com/myproject``::
158
159
$ bzr push --create-prefix sftp://your.name@example.com/~/public_html/myproject
160
2 revision(s) pushed.
161
162
Bazaar will create a ``myproject`` directory on the remote server and
163
push your branch to it.
164
165
**Note:** to use sftp, you may need to install ``paramiko`` and
166
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
167
168
Now anyone can create their own copy of your branch by typing::
169
170
$ bzr branch http://www.example.com/myproject
171
172
173
Publishing your branch with Launchpad
174
=====================================
175
176
Launchpad is a suite of development and hosting tools for free
177
software projects. You can use it to publish your branch.
178
179
If you don't have a Launchpad account, follow the `account signup guide`_
180
and `register an SSH key`_ in your new Launchpad account.
181
182
.. _account signup guide: https://help.launchpad.net/CreatingYourLaunchpadAccount
183
.. _register an SSH key: https://launchpad.net/people/+me/+editsshkeys
184
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
project in Launchpad.
191
192
Now, anyone can create their own copy of your branch by typing::
193
194
$ bzr branch http://bazaar.launchpad.net/~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 http://bazaar.launchpad.net/~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
120
219
=========================================
121
220
122
While you work hard on your branch, others may have committed new code to the
123
main branch. From time to time, you want to merge changes from the main
124
branch into your branch::
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::
125
226
126
227
$ bzr merge
127
Using saved location: http://example.com/code/foobar.dev
228
Using saved location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
128
229
All changes applied successfully.
129
230
130
What was changed locally by merging the main branch?
131
132
::
231
Check what has changed::
133
232
134
233
$ bzr diff
135
=== modified file 'pyfribidi.c'
136
--- pyfribidi.c
137
+++ pyfribidi.c
138
@@ -236,6 +236,7 @@
139
PyMem_Del (logical);
140
PyMem_Del (visual);
141
142
+ /* evil hack! */
143
return result;
144
}
145
146
Commit the changes from the main branch::
147
148
$ bzr commit -m 'merge from main branch'
149
Committed revision 6.
150
151
Note that you may occasionally need to resolve conflicts or make other minor
152
changes (so tests pass say) before committing. For these reasons, merge does
153
not implicitly commit.
154
155
156
Publishing Your Branch
157
======================
158
159
You can simply use rsync to copy your branch to a web server, but using
160
``bzr push`` is the easiest way. Let's assume you want to publish your
161
branch in jod.example.com/foobar.joe and you have sftp access to the server::
162
163
$ bzr push sftp://jod@jod.example.com/public_html/foobar.joe/
164
2 revision(s) pushed.
165
166
Note that to use sftp, your may need to install ''paramiko'' and ''pyCrypto''.
167
See http://bazaar-vcs.org/InstallationFaq for details.
168
169
Now anyone can get your branch with (try it yourself!)::
170
171
bzr branch http://jod.example.com/foobar.joe/
172
173
174
Learning More
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 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
175
264
=============
176
265
177
To learn about bzr topics::
266
You can find out more about Bazaar in the `Bazaar user guide <../../index.html>`_.
267
268
To learn about Bazaar on the command-line::
178
269
179
270
$ bzr help
180
271
181
To learn about bzr commands::
272
To learn about Bazaar commands::
182
273
183
274
$ bzr help commands
184
275
185
276
To learn about the ''foo'' topic or command::
186
277
187
278
$ bzr help foo
188
189
Alternatively, browse the `Bazaar Documentation <../../index.html>`_.
Loggerhead is a web-based interface for Breezy
Version: 2.0.1