summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/write.mdwn10
-rw-r--r--doc/todo/web_reversion.mdwn4
2 files changed, 4 insertions, 10 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 3eade34ee..dbbe83851 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -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
diff --git a/doc/todo/web_reversion.mdwn b/doc/todo/web_reversion.mdwn
index 7cb412f79..784b72e05 100644
--- a/doc/todo/web_reversion.mdwn
+++ b/doc/todo/web_reversion.mdwn
@@ -71,10 +71,6 @@ Peter Gammie has done an initial implementation of the above.
>>> to: --[[Joey]]
>>>> Please change the git pointer above, then. I will work on your branch. -- [[peteg]]
->>> * Would it be better for `rcs_revert` to not commit, and
->>> `rcs_commit_staged` to then be used? This would work for git, but
->>> maybe other RCSs would be problimatic. It would simplifiy the
->>> interface and allow for future mulitple-revert interfaces.
>>> * I quite don't understand why one caller of `git_parse_changes`
>>> needs it to chdir, and not the other one. It's running
>>> in the same git repo either way, and git doesn't need