~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/tutorial.txt

Late bind to PatienceSequenceMatcher to allow plugin to override.

Show diffs side-by-side

added added

removed removed

Lines of Context:
7
7
.. but has been moved into the source tree so it can be kept in sync with
8
8
.. the source and possibly automatically checked.
9
9
 
10
 
===============
11
 
Bazaar Tutorial
12
 
===============
 
10
==================
 
11
Bazaar-NG Tutorial
 
12
==================
13
13
 
14
14
Current for bzr-0.8, 2006-04
15
15
 
18
18
============
19
19
 
20
20
If you are already familiar with decentralized revision control, then
21
 
please feel free to skip ahead to "Introducing Yourself to Bazaar". If,
 
21
please feel free to skip ahead to "Introducing Yourself to Bazaar-NG". If,
22
22
on the other hand, you are familiar with revision control but not
23
23
decentralized revision control, then please start at "How DRCS is
24
24
different." Otherwise, get some coffee or tea, get comfortable and get
34
34
deleted the configuration file for your mailserver or perhaps mauled the
35
35
source code for a pet project. Whatever happened, you have just deleted
36
36
important information that you would desperately like to get back. If this
37
 
has ever happened to you, then you are probably ready for Bazaar.
 
37
has ever happened to you, then you are probably ready for Bazaar-NG.
38
38
 
39
39
Revision control systems (which I'll henceforth call RCS) such as
40
 
Bazaar give you the ability to track changes for a directory by turning
 
40
Bazaar-NG give you the ability to track changes for a directory by turning
41
41
it into something slightly more complicated than a directory that we call
42
42
a **branch**. The branch not only stores how the directory looks right
43
43
now, but also how it looked at various points in the past. Then, when you
75
75
 
76
76
Decentralized Revision Control Systems (which I'll call DRCS after this
77
77
point) deal with this problem by keeping branches on the same machine as
78
 
the client. In Bazaar's case, the branch is kept in the same place as
 
78
the client. In Bazaar-NG's case, the branch is kept in the same place as
79
79
the code that is being version controlled. This allows the user to save
80
80
his changes (**commit**) whenever he wants -- even if he is offline. The
81
81
user only needs internet access when he wants to access the changes in
86
86
the changes for a directory such as file and subdirectory changes.
87
87
Performing this tracking by hand is a awkward process that over time
88
88
becomes unwieldy. That is, until one considers version control tools such
89
 
as Bazaar. These tools automate the process of storing data by creating
 
89
as Bazaar-NG. These tools automate the process of storing data by creating
90
90
a **revision** of the directory tree whenever the user asks. 
91
91
 
92
 
Revision control software such as Bazaar can do much more than just
93
 
storage and performing undo.  For example, with Bazaar developer can
 
92
Revision control software such as Bazaar-NG can do much more than just
 
93
storage and performing undo.  For example, with Bazaar-NG developer can
94
94
take the modifications in one branch of software and apply them to
95
95
another, related, branch -- even if those changes exist in a branch owned
96
96
by somebody else. This allows developers to cooperate without giving write
97
97
access to repository.
98
98
 
99
 
Bazaar remembers the ''ancestry'' of a revision: the previous revisions
 
99
Bazaar-NG remembers the ''ancestry'' of a revision: the previous revisions
100
100
that it is based upon.  A single revision may have more than one direct
101
101
descendant, each with different changes, representing a divergence in the
102
 
evolution of the tree. By branching, Bazaar allows multiple people to
 
102
evolution of the tree. By branching, Bazaar-NG allows multiple people to
103
103
cooperate on the evolution of a project, without all needing to work in
104
104
strict lock-step.  Branching can be useful even for a single developer.
105
105
 
106
 
Introducing yourself to Bazaar
107
 
==============================
 
106
Introducing yourself to Bazaar-NG
 
107
=================================
108
108
 
109
 
Bazaar installs a single new command, **bzr**.  Everything else is a
 
109
Bazaar-NG installs a single new command, **bzr**.  Everything else is a
110
110
subcommand of this.  You can get some help with `bzr help`.  There will be
111
111
more in the future.
112
112
 
115
115
author that is globally unique.  Most people already have one of these: an
116
116
email address. Bzr is smart enough to automatically generate an email
117
117
address by looking up your username and hostname. If you don't like the
118
 
guess that Bazaar makes, then three options exist:
 
118
guess that Bazaar-NG makes, then three options exist:
119
119
 
120
 
 1. Set an email address via ``bzr whoami``.  This is the simplest way.
121
 
 To set a global identity, use::
122
 
 
123
 
     % bzr whoami 'Your Name <email@example.com>'
124
 
 
125
 
 If you'd like to use a different address for a specific branch, enter
126
 
 the branch folder and use::
127
 
 
128
 
     % bzr whoami --branch 'Your Name <email@example.com>'
129
 
 
130
120
 1. Setting the email address in the
131
 
 ``~/.bazaar/bazaar.conf`` [1]_ by adding the following lines. Please note that
 
121
 ``~/.bazaar/bazaar.conf`` by adding the following lines. Please note that
132
122
 ``[DEFAULT]`` is case sensitive::
133
123
 
134
124
    [DEFAULT]
135
125
    email= Your Name <email@isp.com>
136
126
 
137
 
 As above, you can override this settings on a branch by branch basis by
138
 
 creating a branch section in ``~/.bazaar/locations.conf`` and adding the
139
 
 following lines::
 
127
 1. Override the previous setting on a
 
128
 branch by branch basis by creating a branch section in
 
129
 ``~/.bazaar/branches.conf`` by adding the following lines::
140
130
 
141
131
    [/the/directory/to/the/branch]
142
132
    email=Your Name <email@isp.com>
145
135
 variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence) 
146
136
 to your full email address.
147
137
 
148
 
.. [1] On Windows, the users configuration files can be found in the
149
 
   application data directory. So instead of ``~/.bazaar/branch.conf``
150
 
   the configuration file can be found as: 
151
 
   ``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0\branch.conf``.
152
 
   The same is true for ``locations.conf``, ``ignore``, and the
153
 
   ``plugins`` directory.
154
 
 
155
138
Creating a branch
156
139
=================
157
140
 
204
187
giving the name of the directory containing the branch.  bzr also supports
205
188
accessing branches over http, for example::
206
189
 
207
 
    % bzr log http://bazaar-vcs.org/bzr/bzr.dev/
 
190
    % bzr log http://bazaar-ng.org/bzr/bzr.dev/
208
191
 
209
192
By installing bzr plugins you can also access branches over the sftp or
210
193
rsync protocols.
365
348
they only determine whether unversioned files are reported as unknown or
366
349
ignored.
367
350
 
368
 
The ``.bzrignore`` file should normally be versioned, so that new copies
 
351
The ''.bzrignore'' file should normally be versioned, so that new copies
369
352
of the branch see the same patterns::
370
353
 
371
354
    % bzr add .bzrignore
372
355
    % bzr commit -m "Add ignore patterns"
373
356
 
374
357
 
375
 
Global Ignores
376
 
--------------
377
 
 
378
 
There are some ignored files which are not project specific, but more user
379
 
specific. Things like editor temporary files, or personal temporary files.
380
 
Rather than add these ignores to every project, bzr supports a global
381
 
ignore file in ``~/.bazaar/ignore`` [1]_. It has the same syntax as the
382
 
per-project ignore file.
383
 
 
384
 
 
385
358
Examining history
386
359
=================
387
360
 
416
389
    % mkdir src
417
390
    % echo 'int main() {}' > src/simple.c
418
391
    % bzr add src
419
 
    added src
420
 
    added src/simple.c
421
 
    % bzr status
422
 
    added:
423
 
      src/
424
 
      src/simple.c
 
392
    % bzr status
 
393
    A       src/
 
394
    ?       src/simple.c
 
395
    % bzr add src/simple.c
 
396
    % bzr status
 
397
    A       src/
 
398
    A       src/simple.c
425
399
 
426
400
 
427
401
Deleting and removing files
441
415
    % bzr remove -v hello.txt
442
416
    ?       hello.txt
443
417
    % bzr status
444
 
    removed:
445
 
      hello.txt
446
 
      src/
447
 
      src/simple.c
448
 
    unknown:
449
 
      hello.txt
 
418
    ?       hello.txt
 
419
    D       src/
 
420
    D       src/simple.c
450
421
 
451
422
If you remove the wrong file by accident, you can use **bzr revert** to
452
423
restore it.
461
432
something like rsync.  You can also use bzr to fetch a copy.  Because this
462
433
new copy is potentially a new branch, the command is called *branch*::
463
434
 
464
 
    % bzr branch http://bazaar-vcs.org/bzr/bzr.dev 
 
435
    % bzr branch http://bazaar-ng.org/bzr/bzr.dev 
465
436
    % cd bzr.dev
466
437
 
467
438
This copies down the complete history of this branch, so we can do all
526
497
 
527
498
  (The directory that must already exist)
528
499
 
529
 
* The rspush plugin that comes with BzrTools
 
500
* The push plugin that comes with BzrTools
530
501