← 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: 2005-08-18 06:35:46 UTC
  • Revision ID: mbp@sourcefrog.net-20050818063546-3d9916c63dade449
- test tool for converting history to weave files

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
 
 
16
 
Installation
17
 
============
18
 
 
19
 
This guide doesn't describe how to install Bazaar but it's usually very
20
 
easy. You can find installation instructions at:
21
 
 
22
 
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
23
 
- **Windows:** `installation instructions for Windows`_.
24
 
- **Mac OS X:** `installation instructions for Mac OS X`_.
25
 
 
26
 
For other platforms and to install from source code, see the Download_
27
 
and Installation_ pages.
28
 
 
29
 
.. _installation instructions for Windows: http://wiki.bazaar.canonical.com/WindowsDownloads
30
 
.. _installation instructions for Mac OS X: http://wiki.bazaar.canonical.com/MacOSXBundle
31
 
.. _Download: http://wiki.bazaar.canonical.com/Download
32
 
.. _Installation: http://wiki.bazaar.canonical.com/InstallationFaq
33
 
 
34
 
 
35
 
Introducing yourself
36
 
====================
37
 
 
38
 
Bazaar records changes to source code, and it records who made the change.
39
 
The person is identified by their name and email address.  (If you're
40
 
concerned about spam, you don't need to use a real address that you
41
 
actually read, but the convention is that it looks like an email address.)
42
 
 
43
 
Before you start working, let's tell Bazaar who you are.  Using your name
44
 
and email address, instead of John Doe's, type::
45
 
 
46
 
  $ bzr whoami "John Doe <john.doe@gmail.com>"
47
 
 
48
 
You can check what identity is stored in Bazaar's configuration::
49
 
 
50
 
  $ bzr whoami
51
 
  John Doe <john.doe@gmail.com>
52
 
 
53
 
 
54
 
Starting a new project
55
 
======================
56
 
 
57
 
Let's suppose we want to store a new project under Bazaar.  First, we'll
58
 
make a *repository directory* to hold all our work related to this
59
 
project, where developers can create branches to test development of
60
 
specific features or, more generally, modifications to the working file
61
 
set.  
62
 
 
63
 
After creating the repository, change to that directory, and create the
64
 
project's main trunk branch.
65
 
 
66
 
::
67
 
 
68
 
  $ bzr init-repo sample
69
 
  Shared repository with trees (format: 2a)
70
 
  Location:
71
 
    shared repository: sample
72
 
  $ bzr init sample/trunk
73
 
  $ cd sample/trunk
74
 
  Created a repository tree (format: 2a)                                         
75
 
  Using shared repository: /home/john/sample/
76
 
 
77
 
 
78
 
Adding files
79
 
============
80
 
 
81
 
Now that we have the trunk, we need to move to that directory and
82
 
create some example files for the first version of that project.  Create
83
 
a file ``test1.txt`` using a text editor (like emacs, nano, or notepad),
84
 
and save it.  Then we'll "add" the file, which tells bzr we want it to
85
 
track changes::
86
 
 
87
 
  bzr add test1.txt
88
 
 
89
 
and then commit, which saves a snapshot of all versioned files::
90
 
 
91
 
  bzr commit -m "Added first line of text"
92
 
 
93
 
 
94
 
Making changes to your files
95
 
============================
96
 
 
97
 
 
98
 
Let's change a file and commit that change to your branch.
99
 
 
100
 
Edit ``test1.txt`` in your favourite editor, then use ``bzr add`` to tell bzr
101
 
to track changes to this file ::
102
 
 
103
 
  $ echo test test test > test1.txt 
104
 
  $ bzr add test1.txt
105
 
  adding test1.txt
106
 
 
107
 
`bzr diff` shows the changes between the last revision in this branch, and your
108
 
current tree (or, with the ``-r`` option, between any two trees). ::
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"
120
 
  Committing to: /home/john/sample/trunk/                             
121
 
  added test1.txt
122
 
  Committed revision 1.
123
 
 
124
 
Viewing the revision log
125
 
========================
126
 
 
127
 
You can see the history of your branch by browsing its log::
128
 
 
129
 
  $ bzr log
130
 
  revno: 1
131
 
  committer: John Doe <john.doe@gmail.com>
132
 
  branch nick: trunk
133
 
  timestamp: Mon 2006-10-08 17:46:22 +0000
134
 
  message:
135
 
    Initial import
136
 
 
137
 
 
138
 
Publishing your branch on Launchpad
139
 
===================================
140
 
 
141
 
Launchpad is a suite of development and hosting tools for
142
 
software projects. You can use it to publish your branch.  (You can 
143
 
also publish branches onto your own server or other hosting services.)
144
 
 
145
 
The steps to publishing branches on Launchpad are:
146
 
 
147
 
1. Create a Launchpad account: visit the `Launchpad login page`_ and choose to create a new account.
148
 
    
149
 
.. _Launchpad login page: https://launchpad.net/+login
150
 
    
151
 
2. Bazaar uses the SSH encryption and authentication protocol to connect
152
 
   to Launchpad.  You need to first `create an SSH key`_ on your own computer,
153
 
   by running the command::
154
 
    
155
 
       $ ssh-keygen
156
 
 
157
 
.. _create an SSH key: https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair    
158
 
       
159
 
3. `Upload your SSH public key to Launchpad`_.
160
 
 
161
 
.. _Upload your SSH public key to Launchpad: https://launchpad.net/~/+editsshkeys
162
 
    
163
 
4. `Make a team for your project`_.  Even if you're starting as the only
164
 
   developer on this project, creating a new now will let you more easily 
165
 
   add other people later.
166
 
 
167
 
.. _Make a team for your project: https://help.launchpad.net/Teams/CreatingAndRunning
168
 
      
169
 
5. `Create a project`_.
170
 
  
171
 
.. _Create a project: https://help.launchpad.net/Projects/Registering
172
 
 
173
 
6. Tell Bazaar your Launchpad account name.  If your account is john.doe, type ::
174
 
  
175
 
      $ bzr launchpad-login john.doe
176
 
 
177
 
7. `Push the branch for your project`_.  Once you've committed your changes 
178
 
   locally, you can publish them as the trunk of your new project by saying
179
 
    
180
 
       $ bzr push lp:~sample-developers/sample/trunk
181
 
       
182
 
   (Of course, using the team and project names you just chose.)
183
 
 
184
 
.. _Push the branch for your project: https://help.launchpad.net/Code/UploadingABranch
185
 
 
186
 
Creating your own copy of another branch
187
 
========================================
188
 
 
189
 
To work with someone else's code, you can make your own copy of their
190
 
branch. Let's take a real-world example, Bazaar's GTK interface::
191
 
 
192
 
  $ bzr init-repo ~/bzr-gtk
193
 
  $ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
194
 
  Branched 292 revision(s).
195
 
 
196
 
Bazaar will download all the files and complete revision history from the
197
 
bzr-gtk project's trunk branch and create a copy called ``john``.
198
 
 
199
 
Now, you have your own copy of the branch and can commit changes with
200
 
or without a net connection. You can share your branch at any time by
201
 
publishing it and, if the  bzr-gtk team want to use your work, Bazaar
202
 
makes it easy for them to merge your branch back into their trunk branch.
203
 
 
204
 
 
205
 
Updating your branch from the main branch
206
 
=========================================
207
 
 
208
 
While you commit changes to your branch, it's likely that other people will
209
 
also continue to commit code to the parent branch.
210
 
 
211
 
To make sure your branch stays up to date, you should merge changes from
212
 
the parent into your personal branch::
213
 
 
214
 
  $ bzr merge
215
 
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
216
 
  All changes applied successfully.
217
 
 
218
 
Check what has changed::
219
 
 
220
 
  $ bzr diff
221
 
 
222
 
If different branches have made changes to the same areas of the same
223
 
files, then merging them may generate conflicts.  When this happens,
224
 
Bazaar puts text markers like ``<<<<<<<`` into the files, and records them
225
 
in a list of conflicted files.  You should edit the files to reflect the
226
 
way you want to resolve the conflicts, use ``bzr diff`` to check the
227
 
changes, and then ``bzr resolve`` to mark them as resolved.
228
 
 
229
 
If you're happy with the changes, you can commit them to your personal
230
 
branch::
231
 
 
232
 
  $ bzr commit -m "Merge from main branch"
233
 
  Committed revision 295.
234
 
 
235
 
 
236
 
Learning more
237
 
=============
238
 
 
239
 
You can find out more about Bazaar in the
240
 
`Bazaar User Guide <../user-guide/index.html>`_.
241
 
 
242
 
To learn about Bazaar on the command-line::
243
 
 
244
 
  $ bzr help
245
 
 
246
 
To learn about the ''foo'' topic or command::
247
 
 
248
 
  $ bzr help foo
249
 
 
250
 
Licence
251
 
=======
252
 
 
253
 
Copyright 2007-2011 Canonical Ltd. Bazaar is free software, and you
254
 
may use, modify and redistribute both Bazaar and this document under
255
 
the terms of the GNU General Public License version 2 or later. See
256
 
<http://www.gnu.org/licenses/>.