Rev 2517: Update tutorial text (Matthew Fuller) in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Thu Jun 7 14:50:18 BST 2007
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 2517
revision-id: pqm at pqm.ubuntu.com-20070607135016-0u2o57cfwa9ts265
parent: pqm at pqm.ubuntu.com-20070607132155-dn02612f4o14a1no
parent: abentley at panoramicfeedback.com-20070607125547-hm8sfjmq69p1e8s8
committer: Canonical.com Patch Queue Manager<pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Thu 2007-06-07 14:50:16 +0100
message:
Update tutorial text (Matthew Fuller)
modified:
doc/tutorial.txt tutorial.txt-20050804190939-9dcbba2ef053bc84
------------------------------------------------------------
revno: 2495.2.5
merged: abentley at panoramicfeedback.com-20070607125547-hm8sfjmq69p1e8s8
parent: abentley at panoramicfeedback.com-20070607125251-hd7pueyh1exfvu4b
committer: Aaron Bentley <abentley at panoramicfeedback.com>
branch nick: bzr.docs
timestamp: Thu 2007-06-07 08:55:47 -0400
message:
Zap trailing whitespace
------------------------------------------------------------
revno: 2495.2.4
merged: abentley at panoramicfeedback.com-20070607125251-hd7pueyh1exfvu4b
parent: abentley at panoramicfeedback.com-20070607125207-8ss1ncu3m88fgfqm
parent: fullermd at over-yonder.net-20070606095255-zogzpvrnhh5su387
committer: Aaron Bentley <abentley at panoramicfeedback.com>
branch nick: bzr.docs
timestamp: Thu 2007-06-07 08:52:51 -0400
message:
Update tutorial text (Matthew Fuller)
------------------------------------------------------------
revno: 2495.4.14
merged: fullermd at over-yonder.net-20070606095255-zogzpvrnhh5su387
parent: fullermd at over-yonder.net-20070606094841-btejyqo11l309q1j
committer: Matthew Fuller <fullermd at over-yonder.net>
branch nick: tutorial-updates
timestamp: Wed 2007-06-06 04:52:55 -0500
message:
Be more consistent about using `` around options and filenames.
------------------------------------------------------------
revno: 2495.4.13
merged: fullermd at over-yonder.net-20070606094841-btejyqo11l309q1j
parent: fullermd at over-yonder.net-20070606094702-k1ney72w3wktv3ev
committer: Matthew Fuller <fullermd at over-yonder.net>
branch nick: tutorial-updates
timestamp: Wed 2007-06-06 04:48:41 -0500
message:
$BZREMAIL has been spelt $BZR_EMAIL for almost a year now, so it's
probably time to tell the tutorial about it...
------------------------------------------------------------
revno: 2495.4.12
merged: fullermd at over-yonder.net-20070606094702-k1ney72w3wktv3ev
parent: fullermd at over-yonder.net-20070606093909-stozkguj77gorg94
committer: Matthew Fuller <fullermd at over-yonder.net>
branch nick: tutorial-updates
timestamp: Wed 2007-06-06 04:47:02 -0500
message:
Adjust some stuff on the Introducing Yourself section so that it
literal's and blockquote's properly.
------------------------------------------------------------
revno: 2495.4.11
merged: fullermd at over-yonder.net-20070606093909-stozkguj77gorg94
parent: fullermd at over-yonder.net-20070606093102-icchoupo52p6eiyq
committer: Matthew Fuller <fullermd at over-yonder.net>
branch nick: tutorial-updates
timestamp: Wed 2007-06-06 04:39:09 -0500
message:
Use `` instead of ` around a bunch of options and env variable namings
when talking about editor settings.
------------------------------------------------------------
revno: 2495.4.10
merged: fullermd at over-yonder.net-20070606093102-icchoupo52p6eiyq
parent: fullermd at over-yonder.net-20070530145253-hvlcypma2jhexcvk
committer: Matthew Fuller <fullermd at over-yonder.net>
branch nick: tutorial-updates
timestamp: Wed 2007-06-06 04:31:02 -0500
message:
Be consistent about using `` instead of ** around commands.
There are some places that command _names_ are left in **'s, on the
theory that they're really describing concepts rather than commands.
------------------------------------------------------------
revno: 2495.2.3
merged: abentley at panoramicfeedback.com-20070607125207-8ss1ncu3m88fgfqm
parent: aaron.bentley at utoronto.ca-20070527184754-p0w83p0v54ejks8s
parent: pqm at pqm.ubuntu.com-20070607002124-64z9d0o6x0e9iwbl
committer: Aaron Bentley <abentley at panoramicfeedback.com>
branch nick: bzr.docs
timestamp: Thu 2007-06-07 08:52:07 -0400
message:
merge from bzr.dev
=== modified file 'doc/tutorial.txt'
--- a/doc/tutorial.txt 2007-05-30 14:52:53 +0000
+++ b/doc/tutorial.txt 2007-06-07 12:55:47 +0000
@@ -129,21 +129,24 @@
% bzr whoami --branch "Your Name <email at example.com>"
- #. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by adding the following lines.
- Please note that ``[DEFAULT]`` is case sensitive::
- [DEFAULT]
- email= Your Name <email at isp.com>
-
- As above, you can override this settings on a branch by branch basis by
- creating a branch section in ``~/.bazaar/locations.conf`` and adding the
- following lines::
- [/the/path/to/the/branch]
- email=Your Name <email at isp.com>
+ #. Setting the email address in the ``~/.bazaar/bazaar.conf`` [1]_ by
+ adding the following lines. Please note that ``[DEFAULT]`` is case
+ sensitive::
+
+ [DEFAULT]
+ email=Your Name <email at isp.com>
+
+ As above, you can override this settings on a branch by branch basis
+ by creating a branch section in ``~/.bazaar/locations.conf`` and
+ adding the following lines::
+
+ [/the/path/to/the/branch]
+ email=Your Name <email at isp.com>
#. Overriding the two previous options by setting the global environment
- variable ``$BZREMAIL`` or ``$EMAIL`` (``$BZREMAIL`` will take precedence)
- to your full email address.
+ variable ``$BZR_EMAIL`` or ``$EMAIL`` (``$BZR_EMAIL`` will take
+ precedence) to your full email address.
.. [1] On Windows, the users configuration files can be found in the
application data directory. So instead of ``~/.bazaar/branch.conf``
@@ -187,7 +190,7 @@
hello.txt
-If you add the wrong file, simply use **bzr remove** to make it
+If you add the wrong file, simply use ``bzr remove`` to make it
unversioned again. This does not delete the working copy in this case,
though it may in others [2]_.
@@ -202,7 +205,7 @@
All history is stored in a branch, which is just an on-disk directory
containing control files. By default there is no separate repository or
database as used in svn or svk. You can choose to create a repository if
-you want to (see the **bzr init-repo** command). You may wish to do this
+you want to (see the ``bzr init-repo`` command). You may wish to do this
if you have very large branches, or many branches of a moderately sized
project.
@@ -243,7 +246,7 @@
modified:
foo
-**bzr status** hides "boring" files that are either unchanged or ignored.
+``bzr status`` hides "boring" files that are either unchanged or ignored.
The status command can optionally be given the name of some files or
directories to check.
@@ -262,19 +265,20 @@
+hello world
-With the ''-r'' option, the tree is compared to an earlier revision, or
+With the ``-r`` option, the tree is compared to an earlier revision, or
the differences between two versions are shown::
% bzr diff -r 1000.. # everything since r1000
% bzr diff -r 1000..1100 # changes from 1000 to 1100
-The --diff-options option causes bzr to run the external diff program,
+The ``--diff-options`` option causes bzr to run the external diff program,
passing options. For example::
% bzr diff --diff-options --side-by-side foo
-Some projects prefer patches to show a prefix at the start of the path for
-old and new files. The --prefix option can be used to provide such a prefix.
+Some projects prefer patches to show a prefix at the start of the path
+for old and new files. The ``--prefix`` option can be used to provide
+such a prefix.
As a shortcut, ``bzr diff -p1`` produces a form that works with the
command ``patch -p1``.
@@ -290,7 +294,7 @@
The **commit** command takes a message describing the changes in the
revision. It also records your userid, the current time and timezone, and
the inventory and contents of the tree. The commit message is specified
-by the ''-m'' or ''--message'' option. You can enter a multi-line commit
+by the ``-m`` or ``--message`` option. You can enter a multi-line commit
message; in most shells you can enter this just by leaving the quotes open
at the end of the line.
@@ -298,7 +302,7 @@
% bzr commit -m "added my first file"
-You can also use the -F option to take the message from a file. Some
+You can also use the ``-F`` option to take the message from a file. Some
people like to make notes for a commit message while they work, then
review the diff to make sure they did what they said they did. (This file
can also be useful when you pick up your work after a break.)
@@ -306,10 +310,10 @@
Message from an editor
======================
-If you use neither the `-m` nor the `-F` option then bzr will open an
+If you use neither the ``-m`` nor the ``-F`` option then bzr will open an
editor for you to enter a message. The editor to run is controlled by
-your `$VISUAL` or `$EDITOR` environment variable, which can be overridden
-by the `editor` setting in to ~/.bazaar/bazaar.conf; `$BZR_EDITOR` will
+your ``$VISUAL`` or ``$EDITOR`` environment variable, which can be overridden
+by the ``editor`` setting in ``~/.bazaar/bazaar.conf``; ``$BZR_EDITOR`` will
override either of the above mentioned editor options. If you quit the
editor without making any changes, the commit will be cancelled.
@@ -332,9 +336,9 @@
If you've made some changes and don't want to keep them, use the
**revert** command to go back to the previous head version. It's a good
-idea to use **bzr diff** first to see what will be removed. By default the
+idea to use ``bzr diff`` first to see what will be removed. By default the
revert command reverts the whole tree; if file or directory names are
-given then only those ones will be affected. **revert** also clears the
+given then only those ones will be affected. ``bzr revert`` also clears the
list of pending merges revisions.
Ignoring files
@@ -344,7 +348,7 @@
such as editor backups, object or bytecode files, and built programs. You
can simply not add them, but then they'll always crop up as unknown files.
You can also tell bzr to ignore these files by adding them to a file
-called ''.bzrignore'' at the top of the tree.
+called ``.bzrignore`` at the top of the tree.
This file contains a list of file wildcards (or "globs"), one per line.
Typical contents are like this::
@@ -357,14 +361,14 @@
If a glob contains a slash, it is matched against the whole path from the
top of the tree; otherwise it is matched against only the filename. So
the previous example ignores files with extension ``.o`` in all
-subdirectories, but this example ignores only config.h at the top level
+subdirectories, but this example ignores only ``config.h`` at the top level
and HTML files in ``doc/``::
./config.h
doc/*.html
To get a list of which files are ignored and what pattern they matched,
-use ''bzr ignored''::
+use ``bzr ignored``::
% bzr ignored
config.h ./config.h
@@ -398,11 +402,11 @@
bzr log
-------
-The **bzr log** command shows a list of previous revisions. The **bzr log
---forward** command does the same in chronological order to get most
+The ``bzr log`` command shows a list of previous revisions. The ``bzr log
+--forward`` command does the same in chronological order to get most
recent revisions printed at last.
-As with bzr diff, bzr log supports the -r argument::
+As with ``bzr diff``, ``bzr log`` supports the ``-r`` argument::
% bzr log -r 1000.. # Revision 1000 and everything after it
% bzr log -r ..1000 # Everything up to and including r1000
@@ -413,7 +417,7 @@
Branch statistics
=================
-The **bzr info** command shows some summary information about the working
+The ``bzr info`` command shows some summary information about the working
tree and the branch history.
@@ -439,9 +443,9 @@
You can delete files or directories by just deleting them from the working
directory. This is a bit different to CVS, which requires that you also
-do **cvs remove**.
+do ``cvs remove``.
- **bzr remove** makes the file un-versioned, but may or may not delete
+ ``bzr remove`` makes the file un-versioned, but may or may not delete
the working copy [2]_. This is useful when you add the wrong file,
or decide that a file should actually not be versioned.
@@ -458,7 +462,7 @@
unknown:
hello.txt
-If you remove the wrong file by accident, you can use **bzr revert** to
+If you remove the wrong file by accident, you can use ``bzr revert`` to
restore it.
@@ -500,8 +504,8 @@
Merging from related branches
=============================
-If two branches have diverged (both have unique changes) then **bzr
-merge** is the appropriate command to use. Merge will automatically
+If two branches have diverged (both have unique changes) then ``bzr
+merge`` is the appropriate command to use. Merge will automatically
calculate the changes that exist in the branch you're merging from that
are not in your branch and attempt to apply them in your branch.
@@ -548,7 +552,7 @@
(The destination directory must already exist unless the
``--create-prefix`` option is used.)
-* Another option is the rspush plugin that comes with BzrTools, which
+* Another option is the ``rspush`` plugin that comes with BzrTools, which
uses rsync to push the changes to the revision history and the working
tree.
@@ -574,8 +578,8 @@
This will apply all of the uncommitted changes you made in OLDDIR to NEWDIR.
It will not apply committed changes, even if they could be applied to NEWDIR
-with a regular merge. The changes will remain in OLDDIR, but you can use **bzr
-revert OLDDIR** to remove them, once you're satisfied with NEWDIR.
+with a regular merge. The changes will remain in OLDDIR, but you can use ``bzr
+revert OLDDIR`` to remove them, once you're satisfied with NEWDIR.
NEWDIR does not have to be a copy of OLDDIR, but they should be related.
The more different they are, the greater the chance of conflicts.
More information about the bazaar-commits
mailing list