Merge branch 'master' into git-anon

[git.ikiwiki.info.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 0d244e1f544def88cf38314139cc9892fde64592..5a5db6be05e7825769e43c784a97694d68e36691 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -820,6 +820,15 @@ it up in the history.
 
 It's ok if this is not implemented, and throws an error.
 
+#### `rcs_test_receive()`
+
+This is used to test if changes pushed into the RCS should be accepted.
+Ikiwiki will be running as a pre-receive hook (or equivilant) and should
+examine the incoming changes, decide if they are allowed, and communicate
+that to the RCS.
+
+This is optional, and doesn't make sense for all RCSs.
+
 ### PageSpec plugins
 
 It's also possible to write plugins that add new functions to