/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

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

  • Committer: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/hooks.txt
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/hooks-help.html>`_ in the User Reference.
 
12
 
 
13
Most hooks are run on the client, but a few are run on the server.  (Also
 
14
see the `push-and-update plugin`_ that handles one special case of
 
15
server-side operations.)
 
16
 
 
17
.. _push-and-update plugin: http://doc.bazaar.canonical.com/plugins/en/push-and-update-plugin.html
10
18
 
11
19
Using hooks
12
20
-----------
13
21
 
14
 
To use a hook, you should `write a plugin <#writing-a-plugin>`_.  Instead of
 
22
To use a hook, you should `write a plugin`_.  Instead of
15
23
creating a new command, this plugin will define and install the hook.  Here's
16
24
an example::
17
25
 
25
33
    branch.Branch.hooks.install_named_hook('post_push', post_push_hook,
26
34
                                     'My post_push hook')
27
35
 
 
36
.. _write a plugin: http://doc.bazaar.canonical.com/plugins/en/plugin-development.html
 
37
 
28
38
To use this example, create a file named ``push_hook.py``, and stick it in
29
39
``plugins`` subdirectory of your configuration directory.  (If you have never
30
40
installed any plugins, you may need to create the ``plugins`` directory).
31
41
 
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
42
That's it!  The next time you push, it should show "The new revno is...".
42
43
Of course, hooks can be much more elaborate than this, because you have the
43
44
full power of Python at your disposal.  Now that you know how to use hooks,
44
45
what you do with them is up to you.
45
46
 
46
 
Standard hooks
47
 
--------------
 
47
The plugin code does two things.  First, it defines a function that will be
 
48
run after ``push`` completes.  (It could instead use an instance method or
 
49
a callable object.)  All push hooks take a single argument, the
 
50
``push_result``.
48
51
 
49
 
For a complete list of hooks and their parameters, see `Hooks
50
 
<../user-reference/bzr_man.html#hooks>`_ in the User Reference.
 
52
Second, the plugin installs the hook.  The first argument ``'post_push'``
 
53
identifies where to install the hook.  The second argument is the hook
 
54
itself.  The third argument is a name ``'My post_push hook'``, which can be
 
55
used in progress messages and error messages.
51
56
 
52
57
Debugging hooks
53
58
---------------