7
7
One way to customize Bazaar's behaviour is with *hooks*. Hooks allow you to
8
8
perform actions before or after certain Bazaar operations. The operations
9
9
include ``commit``, ``push``, ``pull``, and ``uncommit``.
10
For a complete list of hooks and their parameters, see `Hooks
11
<../user-reference/bzr_man.html#hooks>`_ in the User Reference.
13
Most hooks are run on the client, but a few are run on the server. (Also
14
see the `bzr-push-and-update`_ plugin that handles one special case of
15
server-side operations.)
17
.. _bzr-push-and-update: https://launchpad.net/bzr-push-and-update/
29
37
``plugins`` subdirectory of your configuration directory. (If you have never
30
38
installed any plugins, you may need to create the ``plugins`` directory).
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``.
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
41
40
That's it! The next time you push, it should show "The new revno is...".
42
41
Of course, hooks can be much more elaborate than this, because you have the
43
42
full power of Python at your disposal. Now that you know how to use hooks,
44
43
what you do with them is up to you.
45
The plugin code does two things. First, it defines a function that will be
46
run after ``push`` completes. (It could instead use an instance method or
47
a callable object.) All push hooks take a single argument, the
49
For a complete list of hooks and their parameters, see `Hooks
50
<../user-reference/bzr_man.html#hooks>`_ in the User Reference.
50
Second, the plugin installs the hook. The first argument ``'post_push'``
51
identifies where to install the hook. The second argument is the hook
52
itself. The third argument is a name ``'My post_push hook'``, which can be
53
used in progress messages and error messages.
added
removed
doc/en/user-guide/hooks.txt
