← 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

  • Committer: Martin Pool
  • Date: 2005-07-04 13:08:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050704130854-7fbef398256b8cab
- start code for built-in diff3-style resolve

- test cases for this

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-reference/hooks.txt
1
 
###############
2
 
Hooks Reference 
3
 
###############
4
 
 
5
 
post_push
6
 
#########
7
 
 
8
 
Run after ``push`` has completed.
9
 
 
10
 
The hook signature is (push_result), containing the members
11
 
(source, local, master, old_revno, old_revid, new_revno, new_revid)
12
 
where local is the local target branch or None, master is the target 
13
 
master branch, and the rest should be self-explanatory. The source
14
 
is read-locked and the target branches are write-locked. Source will
15
 
be the local low-latency branch.
16
 
 
17
 
 
18
 
post_pull
19
 
#########
20
 
Run after ``pull`` has completed.
21
 
 
22
 
The hook signature is (push_result) containing the members
23
 
(source, local, master, old_revno, old_revid, new_revno, new_revid)
24
 
where local is the local target branch or None, master is the target 
25
 
master branch, and the rest should be self explanatory. The source
26
 
is read-locked and the target branches are write-locked. Source will
27
 
be the local low-latency branch.
28
 
 
29
 
pre_commit
30
 
##########
31
 
Run prefore ``commit`` has completed.
32
 
 
33
 
The hook signature is (local, master, old_revno, old_revid, future_revno,
34
 
future_revid, tree_delta, future_tree) where old_revno is NULL_REVISION for
35
 
the first commit to a branch, tree_delta is a TreeDelta object describing
36
 
changes from the basis revision, and future_tree is an in-memory tree
37
 
obtained from CommitBuilder.revision_tree(). Hooks MUST NOT modify tree_delta
38
 
and future_tree.
39
 
 
40
 
post_commit
41
 
###########
42
 
Run after ``commit`` has completed.
43
 
 
44
 
The hook signature is (local, master, old_revno, old_revid, new_revno,
45
 
new_revid) old_revid is NULL_REVISION for the first commit to a branch.
46
 
 
47
 
post_uncommit
48
 
#############
49
 
Run after ``uncommit`` has completed.
50
 
 
51
 
The api signature is (local, master, old_revno, old_revid, new_revno,
52
 
new_revid) where local is the local branch or None, master is the target
53
 
branch, and an empty branch receives new_revno of 0, new_revid of None.
54
 
 
55
 
set_rh
56
 
######
57
 
Run after the branch's revision history has been modified (push, pull, commit
58
 
and uncommit can all modify the revision history).
59
 
 
60
 
The hook signature is (branch, revision_history), and the branch will be
61
 
write-locked.
62
 
 
63
 
See also `Using Hooks <../user-guide/hooks.html>`_.