← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/hooks.txt

  • Committer: Martin Pool
  • Date: 2008-10-29 06:10:45 UTC
  • mfrom: (3786.1.2 doc-hooks)
  • mto: This revision was merged to the branch mainline in revision 3806.
  • Revision ID: mbp@sourcefrog.net-20081029061045-q8fpbt0v1bdag0mt
Merge and tweak hook documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/hooks.txt
12
12
 
13
13
.. _Using hooks: ../user-guide/index.html#using-hooks
14
14
 
15
 
The class of each hook is given immediately after each hook type below.
 
15
The class that contains each hook is given in parentheses immediately
 
16
after each hook type below.
 
17
 
 
18
Each description also indicates whether the hook runs on the client (the
 
19
machine where bzr was invoked) or the server (the machine addressed by
 
20
the branch URL).  These may be, but are not necessarily, the same machine.
 
21
 
 
22
Plugins (including hooks) are run on the server if any of these is true:
 
23
 
 
24
  * The remote branch is on the same machine as the client, and the client
 
25
    has plugins enabled.
 
26
 
 
27
  * The connection is via a smart server (accessed with a URL starting with
 
28
    "bzr://", "bzr+ssh://" or "bzr+http://", or accessed via a "http://"
 
29
    URL when a smart server is available via HTTP), and that server has
 
30
    plugins enabled.
16
31
 
17
32
 
18
33
open (Branch)
19
34
-------------
20
35
 
21
36
Called after a Branch object is opened, with the Branch object.
 
37
Runs on the client and on the server.
22
38
 
23
39
 
24
40
post_push (Branch)
25
41
------------------
26
42
 
27
43
Run after ``push`` has completed.
 
44
Runs on the client.
28
45
 
29
46
The hook signature is (push_result), containing the members
30
47
 
60
77
------------------
61
78
 
62
79
Run after ``pull`` has completed.
 
80
Runs on the client.
63
81
 
64
82
The hook signature is (push_result) containing the members
65
83
(source, local, master, old_revno, old_revid, new_revno, new_revid)
73
91
--------------------------
74
92
 
75
93
Run on the working tree before ``commit`` starts processing it.
 
94
Runs on the client.
 
95
 
76
96
Unlike the ``pre_commit`` hook (see below), the ``start_commit`` hook
77
97
can safely change the working tree.
78
98
 
83
103
-------------------
84
104
 
85
105
Run before ``commit`` has completed.
 
106
Runs on the client.
86
107
 
87
108
The hook signature is (local, master, old_revno, old_revid, future_revno,
88
109
future_revid, tree_delta, future_tree) where old_revno is NULL_REVISION for
96
117
--------------------
97
118
 
98
119
Run after ``commit`` has completed.
 
120
Runs on the client.
99
121
 
100
122
The hook signature is (local, master, old_revno, old_revid, new_revno,
101
123
new_revid) old_revid is NULL_REVISION for the first commit to a branch.
105
127
----------------------
106
128
 
107
129
Run after ``uncommit`` has completed.
 
130
Runs on the client.
108
131
 
109
132
The api signature is (local, master, old_revno, old_revid, new_revno,
110
133
new_revid) where local is the local branch or None, master is the target
115
138
-------------------------------
116
139
 
117
140
Run before a branch tip has been changed, while the branch is write-locked.
 
141
Runs on the client and on the server.
118
142
Note that push, pull, commit and uncommit all invoke this hook.
119
143
 
120
144
The hook signature is (params), where params is an object containing
143
167
-------------------------------
144
168
 
145
169
Run after a branch tip has been changed but while the branch is still
146
 
write-locked. Note that push, pull, commit and uncommit all invoke this hook.
 
170
write-locked.
 
171
Runs on the client and on the server.
 
172
Note that push, pull, commit and uncommit all invoke this hook.
147
173
 
148
174
The hook signature is (params), where params is an object containing
149
175
the members
200
226
-------------------------------
201
227
 
202
228
Invoked whenever the server starts serving a directory.
 
229
Runs on the server.
 
230
 
203
231
The hook signature is (backing urls, public url), where:
204
232
 
205
233
  backing_url
213
241
-------------------------------
214
242
 
215
243
Invoked whenever the server stops serving a directory.
 
244
Runs on the server.
 
245
 
216
246
The hook signature is the same as ``server_started``.
217
247
 
218
248
 
220
250
----------------------------
221
251
 
222
252
Called with a LockResult object when a lock has been successfully acquired.
 
253
Runs on the client and on the server.
 
254
 
223
255
(New in 1.8.)
224
256
 
225
257
lock_released (LockDir)
226
258
----------------------------
227
259
 
228
260
Called with a LockResult object when a lock has been successfully released.
 
261
Runs on the client.
 
262
 
229
263
(New in 1.8.)