← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

move reference material out of User Guide into User Reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-reference/hooks.txt
1
 
###############
2
 
Hooks Reference 
3
 
###############
 
1
Hooks
 
2
=====
4
3
 
5
4
post_push
6
 
#########
 
5
---------
7
6
 
8
7
Run after ``push`` has completed.
9
8
 
37
36
    The revision id (eg joe@foo.com-5676566-boa234a) after the push.
38
37
 
39
38
post_pull
40
 
#########
 
39
---------
 
40
 
41
41
Run after ``pull`` has completed.
42
42
 
43
43
The hook signature is (push_result) containing the members
48
48
be the local low-latency branch.
49
49
 
50
50
pre_commit
51
 
##########
 
51
----------
 
52
 
52
53
Run prefore ``commit`` has completed.
53
54
 
54
55
The hook signature is (local, master, old_revno, old_revid, future_revno,
59
60
and future_tree.
60
61
 
61
62
post_commit
62
 
###########
 
63
-----------
 
64
 
63
65
Run after ``commit`` has completed.
64
66
 
65
67
The hook signature is (local, master, old_revno, old_revid, new_revno,
66
68
new_revid) old_revid is NULL_REVISION for the first commit to a branch.
67
69
 
68
70
post_uncommit
69
 
#############
 
71
-------------
 
72
 
70
73
Run after ``uncommit`` has completed.
71
74
 
72
75
The api signature is (local, master, old_revno, old_revid, new_revno,
74
77
branch, and an empty branch receives new_revno of 0, new_revid of None.
75
78
 
76
79
set_rh
77
 
######
 
80
------
 
81
 
78
82
Run after the branch's revision history has been modified (push, pull, commit
79
83
and uncommit can all modify the revision history).
80
84
 
81
85
The hook signature is (branch, revision_history), and the branch will be
82
86
write-locked.
83
87
 
84
 
See also `Using Hooks <../user-guide/hooks.html>`_.
 
88
See also `Using Hooks <../user-guide/index.html#using-hooks>`_.