/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 bzrlib/help_topics/en/hooks.txt

  • Committer: Robert Collins
  • Date: 2008-02-13 03:30:01 UTC
  • mfrom: (3221 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3224.
  • Revision ID: robertc@robertcollins.net-20080213033001-rw70ul0zb02ph856
Merge to fix conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/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
 
10
9
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
 
 
 
10
 
 
11
  source_branch
 
12
    Where the data is being pushed from (read locked).
 
13
    This should be the lowest latency branch.
 
14
 
 
15
  target_branch
 
16
    The direct location where data is being sent (write locked).
 
17
 
 
18
  master_branch
 
19
    Either target_branch, or if the target is a bound branch, it
 
20
    will be the master location (write locked).
 
21
 
 
22
  local_branch
 
23
    If the target is a bound branch, this will be the target
 
24
    branch, else it will be None.
 
25
 
 
26
  old_revno
 
27
    The revision number (eg 10) of the branch before the push.
 
28
 
 
29
  old_revid
 
30
    The revision id (eg joe@foo.com-1234234-aoeua34) before the push.
 
31
 
 
32
  new_revno
 
33
    The revision number (eg 12) of the branch after the push.
 
34
 
 
35
  new_revid
 
36
    The revision id (eg joe@foo.com-5676566-boa234a) after the push.
17
37
 
18
38
post_pull
19
 
#########
 
39
---------
 
40
 
20
41
Run after ``pull`` has completed.
21
42
 
22
43
The hook signature is (push_result) containing the members
27
48
be the local low-latency branch.
28
49
 
29
50
pre_commit
30
 
##########
 
51
----------
 
52
 
31
53
Run prefore ``commit`` has completed.
32
54
 
33
55
The hook signature is (local, master, old_revno, old_revid, future_revno,
38
60
and future_tree.
39
61
 
40
62
post_commit
41
 
###########
 
63
-----------
 
64
 
42
65
Run after ``commit`` has completed.
43
66
 
44
67
The hook signature is (local, master, old_revno, old_revid, new_revno,
45
68
new_revid) old_revid is NULL_REVISION for the first commit to a branch.
46
69
 
47
70
post_uncommit
48
 
#############
 
71
-------------
 
72
 
49
73
Run after ``uncommit`` has completed.
50
74
 
51
75
The api signature is (local, master, old_revno, old_revid, new_revno,
53
77
branch, and an empty branch receives new_revno of 0, new_revid of None.
54
78
 
55
79
set_rh
56
 
######
 
80
------
 
81
 
57
82
Run after the branch's revision history has been modified (push, pull, commit
58
83
and uncommit can all modify the revision history).
59
84
 
60
85
The hook signature is (branch, revision_history), and the branch will be
61
86
write-locked.
62
87
 
63
 
See also `Using Hooks <../user-guide/hooks.html>`_.
 
88
See also `Using hooks`_ in the User Guide.
 
89
 
 
90
.. _Using hooks: ../user-guide/index.html#using-hooks