← 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: Martin Pool
  • Date: 2008-10-20 08:09:33 UTC
  • mto: This revision was merged to the branch mainline in revision 3787.
  • Revision ID: mbp@sourcefrog.net-20081020080933-xba7zw9ffozm6brl
Build zip file from 'make dist' and document this; also tweak standard announcement mail

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/hooks.txt
 
1
Using hooks
 
2
===========
 
3
 
 
4
What is a hook?
 
5
---------------
 
6
 
 
7
One way to customize Bazaar's behaviour is with *hooks*.  Hooks allow you to
 
8
perform actions before or after certain Bazaar operations.  The operations
 
9
include ``commit``, ``push``, ``pull``, and ``uncommit``.
 
10
 
 
11
Using hooks
 
12
-----------
 
13
 
 
14
To use a hook, you should `write a plugin <#writing-a-plugin>`_.  Instead of
 
15
creating a new command, this plugin will define and install the hook.  Here's
 
16
an example::
 
17
 
 
18
    from bzrlib import branch
 
19
 
 
20
 
 
21
    def post_push_hook(push_result):
 
22
        print "The new revno is %d" % push_result.new_revno
 
23
 
 
24
 
 
25
    branch.Branch.hooks.install_named_hook('post_push', post_push_hook,
 
26
                                     'My post_push hook')
 
27
 
 
28
To use this example, create a file named ``push_hook.py``, and stick it in
 
29
``plugins`` subdirectory of your configuration directory.  (If you have never
 
30
installed any plugins, you may need to create the ``plugins`` directory).
 
31
 
 
32
First, we define a function that will be run after ``push`` completes.  We
 
33
could also use an instance method or a callable object.  All push hooks take a
 
34
single argument, the ``push_result``.
 
35
 
 
36
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.
 
40
 
 
41
That's it!  The next time you push, it should show "The new revno is...".
 
42
Of course, hooks can be much more elaborate than this, because you have the
 
43
full power of Python at your disposal.  Now that you know how to use hooks,
 
44
what you do with them is up to you.
 
45
 
 
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