/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/mini-tutorial/index.txt

  • Committer: John Arbash Meinel
  • Date: 2009-12-02 23:09:40 UTC
  • mfrom: (4853.1.1 whitespace)
  • mto: This revision was merged to the branch mainline in revision 4856.
  • Revision ID: john@arbash-meinel.com-20091202230940-7n2aydoxngdqxzld
Strip trailing whitespace from doc files by Patrick Regan.

Resolve one small conflict with another doc edit.
Also, revert the changes to all the .pdf and .png files. We shouldn't
be touching them as they are pure-binary files.

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
 
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
 
 
 
66
 
67
67
**Note for Windows users:** use Windows Explorer to create your
68
 
directories, then right-click in those directories and select 
 
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
 
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
 
 
 
166
 
167
167
**Note:** to use sftp, you may need to install ``paramiko`` and
168
168
``pyCrypto``. See http://bazaar-vcs.org/InstallationFaq for details.
169
169
 
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`_
200
200
Creating your own copy of another branch
201
201
========================================
202
202
 
203
 
To work with someone else's code, you can make your own copy of their 
 
203
To work with someone else's code, you can make your own copy of their
204
204
branch. Let's take a real-world example, Bazaar's GTK interface::
205
205
 
206
206
  $ bzr branch lp:~bzr/bzr-gtk/trunk bzr-gtk.john
207
 
  Branched 292 revision(s).                                                        
 
207
  Branched 292 revision(s).
208
208
 
209
209
Bazaar will download all the files and complete revision history from the
210
210
bzr-gtk project's trunk branch and create a copy called bzr-gtk.john.
211
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 
 
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
215
makes it easy for them to merge your branch back into their trunk branch.
216
216
 
217
217
 
227
227
  $ bzr merge
228
228
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
229
229
  All changes applied successfully.
230
 
            
 
230
 
231
231
Check what has changed::
232
232
 
233
233
  $ bzr diff
234
 
 
 
234
 
235
235
If you're happy with the changes, you can commit them to your personal
236
236
branch::
237
237
 
246
246
send your changes back upstream to the project. The easiest way is to
247
247
use a merge directive.
248
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 
 
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
252
where they can be found.
253
253
 
254
254
Replacing ``mycode.patch``, create your merge directive::
255
255
 
256
256
 $ bzr send -o mycode.patch
257
257
 Using saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
258
 
 
 
258
 
259
259
You can now email the merge directive to the bzr-gtk project who, if
260
260
they choose, can use it merge your work back into the parent branch.
261
 
 
262
 
 
 
261
 
 
262
 
263
263
Learning more
264
264
=============
265
265