summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-09-10 17:17:08 -0400
committerJoey Hess <joey@kitenet.net>2010-09-10 17:17:08 -0400
commitc4ebdd6f467f3361b1f444d9462e10acdbcf9322 (patch)
tree91542980462582541ca97f2da334ca71c8fa053f /doc/plugins
parent163fc34db7f29bc75a05c54b83c2a00c5ad899c2 (diff)
Pass array of names of files that have been deleted to needsbuild hook as second parameter, to allow for plugins that needs access to this information earlier than the delete hook.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 31bb64e68..e60314485 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -177,10 +177,15 @@ function is passed no values.
hook(type => "needsbuild", id => "foo", call => \&needsbuild);
-This allows a plugin to manipulate the list of files that need to be
-built when the wiki is refreshed. The function is passed a reference to an
-array of files that will be rebuilt. It should return an array reference
-that is a modified version of its input. It can add or remove files from it.
+This allows a plugin to observe or even manipulate the list of files that
+need to be built when the wiki is refreshed.
+
+As its first parameter, the function is passed a reference to an array of
+files that will be built. It should return an array reference that is a
+modified version of its input. It can add or remove files from it.
+
+The second parameter passed to the function is a reference to an array of
+files that have been deleted.
### scan