~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

• browse files at revision 3211.7.3
• compare with another revision
• download diff
• download tarball
• view history from revision 3211.7.3

• reverse the comparison (3211.7.3 to 963)
• stop comparing with revision 963

Show diffs side-by-side

added

removed

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_hook('post_push', post_push_hook)

 

26

    branch.Branch.hooks.name_hook(post_push_hook, '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.

 

38

 

 

39

Finally, we name the hook.  This is optional, but it means the hook name can

 

40

be used in progress messages and error messages.

 

41

 

 

42

That's it!  The next time you push, it should show "The new revno is...".

 

43

Of course, hooks can be much more elaborate than this, because you have the

 

44

full power of Python at your disposal.  Now that you know how to use hooks,

 

45

what you do with them is up to you.

 

46

 

 

47

Standard hooks

 

48

--------------

 

49

 

 

50

For a complete list of hooks and their parameters, see `Hooks

 

51

<../user-reference/bzr_man.html#hooks>`_ in the User Reference.

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1