Merge commit 'upstream/master'

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 9f096e4f75243578426cfed39730e6901e686a37..abcabbdc39e43871af4b491b47b1540fda99a34f 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -823,19 +823,22 @@ It's ok if this is not implemented, and throws an error.
 #### `rcs_receive()`
 
 This is called when ikiwiki is running as a pre-receive hook (or
 #### `rcs_receive()`
 
 This is called when ikiwiki is running as a pre-receive hook (or

-equivilant), and is testing if changes pushed into the RCS from an
+equivalent), and is testing if changes pushed into the RCS from an

 untrusted user should be accepted. This is optional, and doesn't make
 sense to implement for all RCSs.
 
 It should examine the incoming changes, and do any sanity 
 checks that are appropriate for the RCS to limit changes to safe file adds,
 untrusted user should be accepted. This is optional, and doesn't make
 sense to implement for all RCSs.
 
 It should examine the incoming changes, and do any sanity 
 checks that are appropriate for the RCS to limit changes to safe file adds,

-removes, and renames. If something bad is found, it should exit
+removes, and changes. If something bad is found, it should exit

 nonzero, to abort the push. Otherwise, it should return a list of
 files that were changed, in the form:
 
        {
                file => # name of file that was changed
                action => # either "add", "change", or "remove"
 nonzero, to abort the push. Otherwise, it should return a list of
 files that were changed, in the form:
 
        {
                file => # name of file that was changed
                action => # either "add", "change", or "remove"

+               path => # temp file containing the new file content, only
+                       # needed for "add"/"change", and only if the file
+                       # is an attachment, not a page

        }
 
 The list will then be checked to make sure that each change is one that
        }
 
 The list will then be checked to make sure that each change is one that