/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

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

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
======================
2
 
Bazaar in five minutes
 
2
Breezy in five minutes
3
3
======================
4
4
 
5
5
Introduction
6
6
============
7
7
 
8
 
Bazaar is a distributed version control system that makes it easier for
 
8
Breezy is a distributed version control system that makes it easier for
9
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
16
16
Installation
17
17
============
18
18
 
19
 
This guide doesn't describe how to install Bazaar but it's usually very
 
19
This guide doesn't describe how to install Breezy but it's usually very
20
20
easy. You can find installation instructions at:
21
21
 
22
 
- **GNU/Linux:** Bazaar is probably in your GNU/Linux distribution already.
 
22
- **GNU/Linux:** Breezy is probably in your GNU/Linux distribution already.
23
23
- **Windows:** `installation instructions for Windows`_.
24
24
- **Mac OS X:** `installation instructions for Mac OS X`_.
25
25
 
35
35
Introducing yourself
36
36
====================
37
37
 
38
 
Bazaar records changes to source code, and it records who made the change.
 
38
Breezy records changes to source code, and it records who made the change.
39
39
The person is identified by their name and email address.  (If you're
40
40
concerned about spam, you don't need to use a real address that you
41
41
actually read, but the convention is that it looks like an email address.)
42
42
 
43
 
Before you start working, let's tell Bazaar who you are.  Using your name
 
43
Before you start working, let's tell Breezy who you are.  Using your name
44
44
and email address, instead of John Doe's, type::
45
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
 
46
  $ brz whoami "John Doe <john.doe@gmail.com>"
 
47
 
 
48
You can check what identity is stored in Breezy's configuration::
 
49
 
 
50
  $ brz whoami
51
51
  John Doe <john.doe@gmail.com>
52
52
 
53
53
 
54
54
Starting a new project
55
55
======================
56
56
 
57
 
Let's suppose we want to store a new project under Bazaar.  First, we'll
 
57
Let's suppose we want to store a new project under Breezy.  First, we'll
58
58
make a *repository directory* to hold all our work related to this
59
59
project, where developers can create branches to test development of
60
60
specific features or, more generally, modifications to the working file
65
65
 
66
66
::
67
67
 
68
 
  $ bzr init-repo sample
 
68
  $ brz init-repo sample
69
69
  Shared repository with trees (format: 2a)
70
70
  Location:
71
71
    shared repository: sample
72
 
  $ bzr init sample/trunk
 
72
  $ brz init sample/trunk
73
73
  $ cd sample/trunk
74
74
  Created a repository tree (format: 2a)                                         
75
75
  Using shared repository: /home/john/sample/
81
81
Now that we have the trunk, we need to move to that directory and
82
82
create some example files for the first version of that project.  Create
83
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
 
84
and save it.  Then we'll "add" the file, which tells brz we want it to
85
85
track changes::
86
86
 
87
 
  bzr add test1.txt
 
87
  brz add test1.txt
88
88
 
89
89
and then commit, which saves a snapshot of all versioned files::
90
90
 
91
 
  bzr commit -m "Added first line of text"
 
91
  brz commit -m "Added first line of text"
92
92
 
93
93
 
94
94
Making changes to your files
97
97
 
98
98
Let's change a file and commit that change to your branch.
99
99
 
100
 
Edit ``test1.txt`` in your favourite editor, then use ``bzr add`` to tell bzr
 
100
Edit ``test1.txt`` in your favourite editor, then use ``brz add`` to tell brz
101
101
to track changes to this file ::
102
102
 
103
103
  $ echo test test test > test1.txt 
104
 
  $ bzr add test1.txt
 
104
  $ brz add test1.txt
105
105
  adding test1.txt
106
106
 
107
 
`bzr diff` shows the changes between the last revision in this branch, and your
 
107
`brz diff` shows the changes between the last revision in this branch, and your
108
108
current tree (or, with the ``-r`` option, between any two trees). ::
109
109
 
110
 
 $ bzr diff
 
110
 $ brz diff
111
111
 === modified file 'test1.txt'
112
112
 --- test1.txt   2007-10-08 17:56:14 +0000
113
113
 +++ test1.txt   2007-10-08 17:46:22 +0000
114
114
 @@ -0,0 +1,1 @@
115
115
 +test test test
116
116
 
117
 
Commit your work to the Bazaar branch::
 
117
Commit your work to the Breezy branch::
118
118
 
119
 
  $ bzr commit -m "Added first line of text"
 
119
  $ brz commit -m "Added first line of text"
120
120
  Committing to: /home/john/sample/trunk/                             
121
121
  added test1.txt
122
122
  Committed revision 1.
126
126
 
127
127
You can see the history of your branch by browsing its log::
128
128
 
129
 
  $ bzr log
 
129
  $ brz log
130
130
  revno: 1
131
131
  committer: John Doe <john.doe@gmail.com>
132
132
  branch nick: trunk
148
148
    
149
149
.. _Launchpad login page: https://launchpad.net/+login
150
150
    
151
 
2. Bazaar uses the SSH encryption and authentication protocol to connect
 
151
2. Breezy uses the SSH encryption and authentication protocol to connect
152
152
   to Launchpad.  You need to first `create an SSH key`_ on your own computer,
153
153
   by running the command::
154
154
    
170
170
  
171
171
.. _Create a project: https://help.launchpad.net/Projects/Registering
172
172
 
173
 
6. Tell Bazaar your Launchpad account name.  If your account is john.doe, type ::
 
173
6. Tell Breezy your Launchpad account name.  If your account is john.doe, type ::
174
174
  
175
 
      $ bzr launchpad-login john.doe
 
175
      $ brz launchpad-login john.doe
176
176
 
177
177
7. `Push the branch for your project`_.  Once you've committed your changes 
178
178
   locally, you can publish them as the trunk of your new project by saying
179
179
    
180
 
       $ bzr push lp:~sample-developers/sample/trunk
 
180
       $ brz push lp:~sample-developers/sample/trunk
181
181
       
182
182
   (Of course, using the team and project names you just chose.)
183
183
 
187
187
========================================
188
188
 
189
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::
 
190
branch. Let's take a real-world example, Breezy's GTK interface::
191
191
 
192
 
  $ bzr init-repo ~/bzr-gtk
193
 
  $ bzr branch lp:~bzr/bzr-gtk/trunk ~/bzr-gtk/john
 
192
  $ brz init-repo ~/brz-gtk
 
193
  $ brz branch lp:~brz/brz-gtk/trunk ~/brz-gtk/john
194
194
  Branched 292 revision(s).
195
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``.
 
196
Breezy will download all the files and complete revision history from the
 
197
brz-gtk project's trunk branch and create a copy called ``john``.
198
198
 
199
199
Now, you have your own copy of the branch and can commit changes with
200
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
 
201
publishing it and, if the  brz-gtk team want to use your work, Breezy
202
202
makes it easy for them to merge your branch back into their trunk branch.
203
203
 
204
204
 
211
211
To make sure your branch stays up to date, you should merge changes from
212
212
the parent into your personal branch::
213
213
 
214
 
  $ bzr merge
215
 
  Merging from saved parent location: http://bazaar.launchpad.net/~bzr/bzr-gtk/trunk
 
214
  $ brz merge
 
215
  Merging from saved parent location: http://bazaar.launchpad.net/~brz/brz-gtk/trunk
216
216
  All changes applied successfully.
217
217
 
218
218
Check what has changed::
219
219
 
220
 
  $ bzr diff
 
220
  $ brz diff
221
221
 
222
222
If different branches have made changes to the same areas of the same
223
223
files, then merging them may generate conflicts.  When this happens,
224
 
Bazaar puts text markers like ``<<<<<<<`` into the files, and records them
 
224
Breezy puts text markers like ``<<<<<<<`` into the files, and records them
225
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.
 
226
way you want to resolve the conflicts, use ``brz diff`` to check the
 
227
changes, and then ``brz resolve`` to mark them as resolved.
228
228
 
229
229
If you're happy with the changes, you can commit them to your personal
230
230
branch::
231
231
 
232
 
  $ bzr commit -m "Merge from main branch"
 
232
  $ brz commit -m "Merge from main branch"
233
233
  Committed revision 295.
234
234
 
235
235
 
236
236
Learning more
237
237
=============
238
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
 
239
You can find out more about Breezy in the
 
240
`Breezy User Guide <../user-guide/index.html>`_.
 
241
 
 
242
To learn about Breezy on the command-line::
 
243
 
 
244
  $ brz help
245
245
 
246
246
To learn about the ''foo'' topic or command::
247
247
 
248
 
  $ bzr help foo
 
248
  $ brz help foo
249
249
 
250
250
Licence
251
251
=======
252
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
 
253
Copyright 2007-2011 Canonical Ltd. Breezy is free software, and you
 
254
may use, modify and redistribute both Breezy and this document under
255
255
the terms of the GNU General Public License version 2 or later. See
256
256
<http://www.gnu.org/licenses/>.