convert rcs_revert to only stage the reversion
[ikiwiki.git] / doc / plugins / write.mdwn
index 3eade34ee1e54244554d704a9b75baa4e1d07a28..dbbe83851c0c5efbb2022d50b7b70e6d9798151a 100644 (file)
@@ -1201,16 +1201,14 @@ Like `rcs_receive`, it should do whatever sanity checks are appropriate
 for the RCS to limit changes to safe changes, and die if a change would
 be unsafe to revert.
 
-#### `rcs_revert(@)`
+#### `rcs_revert($)`
 
 This is called by the revert web interface. It is passed a named
 parameter rev that is the RCS-specific change ID to revert.
 
-Addition named parameters: `message`, and `session` (optional).
-
-It should try to revert the specified rev, which includes committing
-the reversion, and returns undef on _success_ and an error message
-on failure.
+It should try to revert the specified rev, and leave the reversion staged
+so `rcs_commit_staged` will complete it. It should return undef on _success_
+and an error message on failure.
 
 ### PageSpec plugins