~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/using_aliases.txt

  • Committer: Robert Collins
  • Date: 2007-03-08 04:06:06 UTC
  • mfrom: (2323.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 2442.
  • Revision ID: robertc@robertcollins.net-20070308040606-84gsniv56huiyjt4
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Command aliases are an eay way to customize the behaviour of Bazaar-NG. Aliases
 
1
=================================
 
2
Using aliases for Bazaar commands
 
3
=================================
 
4
 
 
5
Command aliases are an easy way to customize the behaviour of Bazaar. Aliases
2
6
are an easy way to create shortcuts for commonly-typed commands, or to set
3
7
defaults for commands.
4
8
 
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
 
9
Command aliases can be defined in the ``[ALIASES]`` section of your
 
10
``.bazaar/bazaar.conf`` file. Aliases start with the alias name, then an
7
11
equal sign, then a command fragment.  Here's an example ALIASES section:
8
12
 
9
13
Examples
19
23
Explanation of examples
20
24
=======================
21
25
 
22
 
 * The first alias makes a new 'recentlog' command that shows the logs for the
 
26
 * The first alias makes a new ``recentlog`` command that shows the logs for the
23
27
   last three revisions
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
 
28
 * The ``ll`` alias shows the last 10 log entries in line format.
 
29
 * the ``commit`` alias sets the default for commit to refuse to commit if new
26
30
   files in the tree are not recognized.
27
 
 * the **diff** alias adds the coveted -p option to diff
28
 
 
 
31
 * the ``diff`` alias adds the coveted -p option to diff
 
32
 
 
33
Using the Aliases
 
34
=================
 
35
The aliases defined above would be used like so: ::
 
36
 
 
37
   % bzr recentlog
 
38
   % bzr ll
 
39
   % bzr commit
 
40
   % bzr diff
29
41
 
30
42
Rules for Aliases
31
43
=================
32
44
 
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.
 
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
 
36
52
 * Aliases can override the standard behaviour of existing commands by giving
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**.
 
53
   an alias name that is the same as the orignal command. For example, default
 
54
   commit is changed with ``commit=commit --strict``.
 
55
 * Aliases cannot refer to other aliases. In other words making a
 
56
   ``lastlog`` alias and referring to it with a ``ll`` alias will not work.
 
57
   This includes aliases that override standard commands
 
58
 * Giving the ``--no-aliases`` to the bzr command will tell it to ignore aliases
 
59
   for that run. For example, running ``bzr --no-aliases commit`` will perform a
 
60
   standard commit instead not do a ``commit --strict``.
47
61