← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/hooks.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-04 18:51:39 UTC
  • mfrom: (2961.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20071104185139-kaio3sneodg2kp71
Authentication ring implementation (read-only)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/hooks.txt
 
1
###########
1
2
Using hooks
2
 
===========
3
 
 
4
 
What is a hook?
5
 
---------------
 
3
###########
6
4
 
7
5
One way to customize Bazaar's behaviour is with *hooks*.  Hooks allow you to
8
6
perform actions before or after certain Bazaar operations.  The operations
9
7
include ``commit``, ``push``, ``pull``, and ``uncommit``.
10
8
 
11
 
Using hooks
12
 
-----------
13
 
 
14
 
To use a hook, you should `write a plugin <#writing-a-plugin>`_.  Instead of
 
9
Using Hooks
 
10
###########
 
11
To use a hook, you should write a `plugin <plugins.html>`_.  Instead of
15
12
creating a new command, this plugin will define and install the hook.  Here's
16
13
an example::
17
14
 
22
19
        print "The new revno is %d" % push_result.new_revno
23
20
 
24
21
 
25
 
    branch.Branch.hooks.install_named_hook('post_push', post_push_hook,
26
 
                                     'My post_push hook')
 
22
    branch.Branch.hooks.install_hook('post_push', post_push_hook)
 
23
    branch.Branch.hooks.name_hook(post_push_hook, 'My post_push hook')
27
24
 
28
25
To use this example, create a file named ``push_hook.py``, and stick it in
29
26
``plugins`` subdirectory of your configuration directory.  (If you have never
34
31
single argument, the ``push_result``.
35
32
 
36
33
Next, we install the hook.  ``'post_push'`` identifies where we want to install
37
 
the hook, and the second parameter is the hook itself.  We also give the hook a
38
 
name 'My post_push hook', which can be used in progress messages and error
39
 
messages.
 
34
the hook, and the second parameter is the hook itself.
 
35
 
 
36
Finally, we name the hook.  This is optional, but it means the hook name can
 
37
be used in progress messages and error messages.
40
38
 
41
39
That's it!  The next time you push, it should show "The new revno is...".
42
40
Of course, hooks can be much more elaborate than this, because you have the
43
41
full power of Python at your disposal.  Now that you know how to use hooks,
44
42
what you do with them is up to you.
45
43
 
46
 
Standard hooks
47
 
--------------
48
 
 
49
 
For a complete list of hooks and their parameters, see `Hooks
50
 
<../user-reference/bzr_man.html#hooks>`_ in the User Reference.
51
 
 
52
 
Debugging hooks
53
 
---------------
54
 
 
55
 
To get a list of installed hooks, use the hidden ``hooks`` command::
56
 
 
57
 
    bzr hooks
 
44
For a complete list of hooks and their parameters, see the `Hooks Reference
 
45
<../user-reference/hooks.html>`_.