← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/using_aliases.txt

  • Committer: Robert Collins
  • Date: 2006-07-20 13:00:31 UTC
  • mto: (1852.9.1 Tree.compare().)
  • mto: This revision was merged to the branch mainline in revision 1890.
  • Revision ID: robertc@robertcollins.net-20060720130031-d26103a427ea10f3
Start tree implementation tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/using_aliases.txt
1
 
Using aliases
2
 
=============
3
 
 
4
 
What are aliases?
5
 
-----------------
6
 
 
7
 
Aliases are an easy way to create shortcuts for commonly-typed commands, or to set
 
1
Command aliases are an eay way to customize the behaviour of Bazaar-NG. Aliases
 
2
are an easy way to create shortcuts for commonly-typed commands, or to set
8
3
defaults for commands.
9
4
 
10
 
Defining aliases
11
 
----------------
 
5
Command aliases can be defined in the **[ALIASES]** section of your
 
6
**.bazaar/bazaar.conf** file. Aliases start with the alias name, then an
 
7
equal sign, then a command fragment.  Here's an example ALIASES section:
12
8
 
13
 
Command aliases can be defined in the ``[ALIASES]`` section of your
14
 
``bazaar.conf`` file. Aliases start with the alias name, then an
15
 
equal sign, then a command fragment.  Here's an example ALIASES section::
 
9
Examples
 
10
========
 
11
A typical example::
16
12
 
17
13
    [ALIASES]
18
14
    recentlog=log -r-3..-1
20
16
    commit=commit --strict
21
17
    diff=diff --diff-options -p
22
18
 
23
 
Here are the explanations of the examples above:
 
19
Explanation of examples
 
20
=======================
24
21
 
25
 
 * The first alias makes a new ``recentlog`` command that shows the logs for the
 
22
 * The first alias makes a new 'recentlog' command that shows the logs for the
26
23
   last three revisions
27
 
 * The ``ll`` alias shows the last 10 log entries in line format.
28
 
 * the ``commit`` alias sets the default for commit to refuse to commit if new
 
24
 * The **ll** alias shows the last 10 log entries in line format.
 
25
 * the **commit** alias sets the default for commit to refuse to commit if new
29
26
   files in the tree are not recognized.
30
 
 * the ``diff`` alias adds the coveted -p option to diff
31
 
 
32
 
Using the aliases
33
 
-----------------
34
 
 
35
 
The aliases defined above would be used like so: ::
36
 
 
37
 
   % bzr recentlog
38
 
   % bzr ll
39
 
   % bzr commit
40
 
   % bzr diff
41
 
 
42
 
Rules for aliases
43
 
-----------------
44
 
 
45
 
 * You can override a portion of the options given in an alias by
46
 
   specifying the new part on the command-line.  For example, if
47
 
   you run ``lastlog -r-5..``, you will only get five line-based log
48
 
   entries instead of 10.  Note that all boolean options have an
49
 
   implicit inverse, so you can override the commit alias with
50
 
   ``commit --no-strict``.
51
 
 
 
27
 * the **diff** alias adds the coveted -p option to diff
 
28
 
 
29
 
 
30
Rules for Aliases
 
31
=================
 
32
 
 
33
 * You can override parts of the options given in an alias by overriding it.
 
34
   For example, if you run **lastlog -r-5..**, you will only get five
 
35
   line-based log entries instead of 10.
52
36
 * Aliases can override the standard behaviour of existing commands by giving
53
 
   an alias name that is the same as the original command. For example, default
54
 
   commit is changed with ``commit=commit --strict``.
55
 
 
56
 
 * Aliases cannot refer to other aliases. In other words making a
57
 
   ``lastlog`` alias and referring to it with a ``ll`` alias will not work.
58
 
   This includes aliases that override standard commands.
59
 
 
60
 
 * Giving the ``--no-aliases`` option to the bzr command will tell it to ignore aliases
61
 
   for that run. For example, running ``bzr --no-aliases commit`` will perform a
62
 
   standard commit instead, not do a ``commit --strict``.
 
37
   an alias name that is thesame as the orignal command. For example, default
 
38
   commit is changed with **commit=commit --strict**.
 
39
 * Aliases can not refer to other aliases. In other words making a
 
40
   **lastlog** alias and referring to it with a **ll** alias will not work.
 
41
 
 
42
This includes aliases that override standard commands
 
43
 
 
44
 * Giving the **--no-aliases** to the bzr command will tell it to ignore aliases
 
45
   for that run. For example, running **bzr --no-aliases commit** will perform a
 
46
   standard commit instead not do a **commit --strict**.
63
47