← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/tutorial.txt

  • Committer: Robert Collins
  • Date: 2007-07-15 15:40:37 UTC
  • mto: (2592.3.33 repository)
  • mto: This revision was merged to the branch mainline in revision 2624.
  • Revision ID: robertc@robertcollins.net-20070715154037-3ar8g89decddc9su
Make GraphIndex accept nodes as key, value, references, so that the method
signature is closer to what a simple key->value index delivers. Also
change the behaviour when the reference list count is zero to accept
key, value as nodes, and emit key, value to make it identical in that case
to a simple key->value index. This may not be a good idea, but for now it
seems ok.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/tutorial.txt
11
11
Bazaar Tutorial
12
12
===============
13
13
 
14
 
Current for bzr-0.91, 2007-08
 
14
Current for bzr-0.16, 2007-05
15
15
 
16
16
 
17
17
Introduction
109
109
Bazaar installs a single new command, **bzr**.  Everything else is a
110
110
subcommand of this.  You can get some help with ``bzr help``. Some arguments 
111
111
are grouped in topics: ``bzr help topics`` to see which topics are available.
 
112
There will be more in the future.
112
113
 
113
114
One function of a version control system is to keep track of who changed
114
115
what.  In a decentralized system, that requires an identifier for each
115
116
author that is globally unique.  Most people already have one of these: an
116
 
email address. Bazaar is smart enough to automatically generate an email
 
117
email address. Bzr is smart enough to automatically generate an email
117
118
address by looking up your username and hostname. If you don't like the
118
119
guess that Bazaar makes, then three options exist:
119
120
 
120
 
1. Set an email address via ``bzr whoami``.  This is the simplest way.
121
 
 
122
 
   To set a global identity, use::
123
 
 
124
 
   % bzr whoami "Your Name <email@example.com>"
125
 
 
126
 
   If you'd like to use a different address for a specific branch, enter
127
 
   the branch folder and use::
128
 
 
129
 
   % bzr whoami --branch "Your Name <email@example.com>"
130
 
 
131
 
#. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
132
 
   adding the following lines.  Please note that  ``[DEFAULT]`` is case
133
 
   sensitive::
134
 
 
135
 
       [DEFAULT]
136
 
       email=Your Name <email@isp.com>
137
 
 
138
 
   As above, you can override this settings on a branch by branch basis
139
 
   by creating a branch section in ``~/.bazaar/locations.conf`` and
140
 
   adding the following lines::
141
 
 
142
 
       [/the/path/to/the/branch]
143
 
       email=Your Name <email@isp.com>
144
 
 
145
 
 
146
 
#. Overriding the two previous options by setting the global environment
147
 
   variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
148
 
   precedence) to your full email address.
 
121
 1. Set an email address via ``bzr whoami``.  This is the simplest way.
 
122
 
 
123
    To set a global identity, use::
 
124
 
 
125
    % bzr whoami "Your Name <email@example.com>"
 
126
 
 
127
    If you'd like to use a different address for a specific branch, enter
 
128
    the branch folder and use::
 
129
 
 
130
    % bzr whoami --branch "Your Name <email@example.com>"
 
131
 
 
132
 #. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
 
133
    adding the following lines.  Please note that  ``[DEFAULT]`` is case
 
134
    sensitive::
 
135
 
 
136
        [DEFAULT]
 
137
        email=Your Name <email@isp.com>
 
138
 
 
139
    As above, you can override this settings on a branch by branch basis
 
140
    by creating a branch section in ``~/.bazaar/locations.conf`` and
 
141
    adding the following lines::
 
142
 
 
143
        [/the/path/to/the/branch]
 
144
        email=Your Name <email@isp.com>
 
145
 
 
146
 
 
147
 #. Overriding the two previous options by setting the global environment
 
148
    variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
 
149
    precedence) to your full email address.
149
150
 
150
151
.. [1] On Windows, the users configuration files can be found in the
151
152
   application data directory. So instead of ``~/.bazaar/branch.conf``
159
160
 
160
161
History is by default stored in the .bzr directory of the branch. In a
161
162
future version of Bazaar, there will be a facility to store it in a
162
 
separate repository, which may be remote.
163
 
 
164
 
We create a new branch by running ``bzr init`` in an existing directory::
 
163
separate repository, which may be remote.  We create a new branch by
 
164
running ``bzr init`` in an existing directory::
165
165
 
166
166
    % mkdir tutorial
167
167
    % cd tutorial
317
317
override either of the above mentioned editor options.  If you quit the
318
318
editor without making any changes, the commit will be cancelled.
319
319
 
320
 
The file that is opened in the editor contains a horizontal line. The part
321
 
of the file below this line is included for information only, and will not
322
 
form part of the commit message. Below the separator is shown the list of
323
 
files that are changed in the commit. You should write your message above
324
 
the line, and then save the file and exit.
325
 
 
326
 
If you would like to see the diff that will be committed as you edit the
327
 
message you can use the ``--show-diff`` option to ``commit``. This will include
328
 
the diff in the editor when it is opened, below the separator and the
329
 
information about the files that will be committed. This means that you can
330
 
read it as you write the message, but the diff itself wont be seen in the
331
 
commit message when you have finished. If you would like parts to be
332
 
included in the message you can copy and paste them above the separator.
333
 
 
334
320
Selective commit
335
321
----------------
336
322
 
459
445
directory.  This is a bit different to CVS, which requires that you also
460
446
do ``cvs remove``.
461
447
 
462
 
``bzr remove`` makes the file un-versioned, but may or may not delete the
463
 
working copy [2]_.  This is useful when you add the wrong file, or decide that
464
 
a file should actually not be versioned. 
 
448
    ``bzr remove`` makes the file un-versioned, but may or may not delete
 
449
    the working copy [2]_.  This is useful when you add the wrong file,
 
450
    or decide that a file should actually not be versioned. 
465
451
 
466
452
::
467
453
 
570
556
  uses rsync to push the changes to the revision history and the working
571
557
  tree.
572
558
 
573
 
* You can also copy the files around manually, by sending a tarball, or using
574
 
  rsync, or other related file transfer methods.  This is usually less safe
575
 
  than using ``push``, but may be faster or easier in some situations.
 
559
You can also use copy the files around manually, by sending a tarball, or
 
560
using rsync, or other related file transfer methods.  This is usually
 
561
less safe than using ``push``, but may be faster or easier in some
 
562
situations.
576
563
 
577
564
Moving changes between trees 
578
565
============================