~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/using_aliases.txt

  • Committer: James Blackwell
  • Date: 2006-03-14 16:22:52 UTC
  • mto: This revision was merged to the branch mainline in revision 1700.
  • Revision ID: jblack@merconline.com-20060314162252-57b09902e2985779
Copied in docs for wiki & First round cleanup

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
 
2
are an easy way to create shortcuts for commonly-typed commands, or to set
 
3
defaults for commands.
 
4
 
 
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:
 
8
 
 
9
Examples
 
10
========
 
11
::
 
12
    [ALIASES]
 
13
    recentlog=log -r-3..-1
 
14
    ll=log --line -r-10..-1
 
15
    commit=commit --strict
 
16
    diff=diff --diff-options -p
 
17
 
 
18
Explanation of examples
 
19
=======================
 
20
 
 
21
 * The first alias makes a new 'recentlog' command that shows the logs for the
 
22
last three revisions
 
23
 * The `ll` alias shows the last 10 log entries in line format.
 
24
 * the `commit` alias sets the default for commit to refuse to commit if new
 
25
files in the tree are not recognized.
 
26
 * the `diff` alias adds the coveted -p option to diff
 
27
 
 
28
 
 
29
Rules for Aliases
 
30
=================
 
31
 
 
32
 * You can override parts of the options given in an alias by overriding it.
 
33
   For example, if you run `lastlog -r-5..`, you will only get five
 
34
   line-based log entries instead of 10.
 
35
 * Aliases can override the standard behaviour of existing commands by giving
 
36
   an alias name that is thesame as the orignal command. For example, default
 
37
   commit is changed with `commit=commit --strict`.
 
38
 * Aliases can not refer to other aliases. In other words making a
 
39
   **lastlog** alias and referring to it with a ***ll*** alias will not work.
 
40
 
 
41
This includes aliases that override standard commands
 
42
 
 
43
 * Giving the `--no-aliases` to the bzr command will tell it to ignore aliases
 
44
for that run. For example, running `bzr --no-aliases commit` will perform a
 
45
standard commit instead not do a `commit --strict`.