← 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: John Arbash Meinel
  • Date: 2005-11-30 15:43:57 UTC
  • mto: (1185.50.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1518.
  • Revision ID: john@arbash-meinel.com-20051130154357-614206b3a7b83cd0
Refactored bzrlib/ui.py into a module with the possibility for multiple ui forms.

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.  We can then have multiple branch directories under here, and
60
 
they'll all store the committed history in the repository.
61
 
 
62
 
::
63
 
 
64
 
  $ bzr init-repo sample
65
 
  Shared repository with trees (format: 2a)
66
 
  Location:
67
 
    shared repository: sample
68
 
  $ bzr init sample/trunk
69
 
  $ cd sample/trunk
70
 
  Created a repository tree (format: 2a)                                         
71
 
  Using shared repository: /home/john/sample/
72
 
 
73
 
 
74
 
Making changes to your files
75
 
============================
76
 
 
77
 
Let's change a file and commit that change to your branch.
78
 
 
79
 
Edit ``test1.txt`` in your favourite editor, then use ``bzr add`` to tell bzr
80
 
to track changes to this file ::
81
 
 
82
 
  $ echo test test test > test1.txt 
83
 
  $ bzr add test1.txt
84
 
  adding test1.txt
85
 
 
86
 
`bzr diff` shows the changes between the last revision in this branch, and your
87
 
current tree (or, with the ``-r`` option, between any two trees). ::
88
 
 
89
 
 $ bzr diff
90
 
 === modified file 'test1.txt'
91
 
 --- test1.txt   2007-10-08 17:56:14 +0000
92
 
 +++ test1.txt   2007-10-08 17:46:22 +0000
93
 
 @@ -0,0 +1,1 @@
94
 
 +test test test
95
 
 
96
 
Commit your work to the Bazaar branch::
97
 
 
98
 
  $ bzr commit -m "Added first line of text"
99
 
  Committing to: /home/john/sample/trunk/                             
100
 
  added test1.txt
101
 
  Committed revision 1.
102
 
 
103
 
Viewing the revision log
104
 
========================
105
 
 
106
 
You can see the history of your branch by browsing its log::
107
 
 
108
 
  $ bzr log
109
 
  revno: 1
110
 
  committer: John Doe <john.doe@gmail.com>
111
 
  branch nick: trunk
112
 
  timestamp: Mon 2006-10-08 17:46:22 +0000
113
 
  message:
114
 
    Initial import
115
 
 
116
 
 
117
 
Publishing your branch on Launchpad
118
 
===================================
119
 
 
120
 
Launchpad is a suite of development and hosting tools for
121
 
software projects. You can use it to publish your branch.  (You can 
122
 
also publish branches onto your own server or other hosting services.)
123
 
 
124
 
The steps to publishing branches on Launchpad are:
125
 
 
126
 
1. Create a Launchpad account: visit the `Launchpad login page`_ and choose to create a new account.
127
 
    
128
 
.. _Launchpad login page: https://launchpad.net/+login
129
 
    
130
 
2. Bazaar uses the SSH encryption and authentication protocol to connect
131
 
   to Launchpad.  You need to first `create an SSH key`_ on your own computer,
132
 
   by running the command::
133
 
    
134
 
       $ ssh-keygen
135
 
 
136
 
.. _create an SSH key: https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair    
137
 
       
138
 
3. `Upload your SSH public key to Launchpad`_.
139
 
 
140
 
.. _Upload your SSH public key to Launchpad: https://launchpad.net/~/+editsshkeys
141
 
    
142
 
4. `Make a team for your project`_.  Even if you're starting as the only
143
 
   developer on this project, creating a new now will let you more easily 
144
 
   add other people later.
145
 
 
146
 
.. _Make a team for your project: https://help.launchpad.net/Teams/CreatingAndRunning
147
 
      
148
 
5. `Create a project`_.
149
 
  
150
 
.. _Create a project: https://help.launchpad.net/Projects/Registering
151
 
 
152
 
6. Tell Bazaar your Launchpad account name.  If your account is john.doe, type ::
153
 
  
154
 
      $ bzr launchpad-login john.doe
155
 
 
156
 
7. `Push the branch for your project`_.  Once you've committed your changes 
157
 
   locally, you can publish them as the trunk of your new project by saying
158
 
    
159
 
       $ bzr push lp:~sample-developers/sample/trunk
160
 
       
161
 
   (Of course, using the team and project names you just chose.)
162
 
 
163
 
.. _Push the branch for your project: https://help.launchpad.net/Code/UploadingABranch
164
 
 
165
 
Creating your own copy of another branch
166
 
========================================
167
 
 
168
 
To work with someone else's code, you can make your own copy of their
169
 
branch. Let's take a real-world example, Bazaar's GTK interface::
170
 
 
171
 
  $ bzr init-repo ~/bzr-gtk
172
 
  $ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
173
 
  Branched 292 revision(s).
174
 
 
175
 
Bazaar will download all the files and complete revision history from the
176
 
bzr-gtk project's trunk branch and create a copy called ``john``.
177
 
 
178
 
Now, you have your own copy of the branch and can commit changes with
179
 
or without a net connection. You can share your branch at any time by
180
 
publishing it and, if the  bzr-gtk team want to use your work, Bazaar
181
 
makes it easy for them to merge your branch back into their trunk branch.
182
 
 
183
 
 
184
 
Updating your branch from the main branch
185
 
=========================================
186
 
 
187
 
While you commit changes to your branch, it's likely that other people will
188
 
also continue to commit code to the parent branch.
189
 
 
190
 
To make sure your branch stays up to date, you should merge changes from
191
 
the parent into your personal branch::
192
 
 
193
 
  $ bzr merge
194
 
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
195
 
  All changes applied successfully.
196
 
 
197
 
Check what has changed::
198
 
 
199
 
  $ bzr diff
200
 
 
201
 
If different branches have made changes to the same areas of the same
202
 
files, then merging them may generate conflicts.  When this happens,
203
 
Bazaar puts text markers like ``<<<<<<<`` into the files, and records them
204
 
in a list of conflicted files.  You should edit the files to reflect the
205
 
way you want to resolve the conflicts, use ``bzr diff`` to check the
206
 
changes, and then ``bzr resolve`` to mark them as resolved.
207
 
 
208
 
If you're happy with the changes, you can commit them to your personal
209
 
branch::
210
 
 
211
 
  $ bzr commit -m "Merge from main branch"
212
 
  Committed revision 295.
213
 
 
214
 
 
215
 
Learning more
216
 
=============
217
 
 
218
 
You can find out more about Bazaar in the
219
 
`Bazaar User Guide <../user-guide/index.html>`_.
220
 
 
221
 
To learn about Bazaar on the command-line::
222
 
 
223
 
  $ bzr help
224
 
 
225
 
To learn about the ''foo'' topic or command::
226
 
 
227
 
  $ bzr help foo
228
 
 
229
 
Licence
230
 
=======
231
 
 
232
 
Copyright 2007-2011 Canonical Ltd. Bazaar is free software, and you
233
 
may use, modify and redistribute both Bazaar and this document under
234
 
the terms of the GNU General Public License version 2 or later. See
235
 
<http://www.gnu.org/licenses/>.