diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/write.mdwn | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 5f0e95a9f..ab2934bf1 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -1051,15 +1051,17 @@ token, that will be passed into `rcs_commit` when committing. For example, it might return the current revision ID of the file, and use that information later when merging changes. -#### `rcs_commit($$$;$$)` +#### `rcs_commit($$$;$$$)` -Passed a file, message, token (from `rcs_prepedit`), user, and ip address. +Passed a file, message, token (from `rcs_prepedit`), user, ip address, +and optionally the username component of the committer's email address. Should try to commit the file. Returns `undef` on *success* and a version of the page with the rcs's conflict markers on failure. -#### `rcs_commit_staged($$$)` +#### `rcs_commit_staged($$$;$)` -Passed a message, user, and ip address. Should commit all staged changes. +Passed a message, user, ip address, and optionally the username component of +the committer's email address. Should commit all staged changes. Returns undef on success, and an error message on failure. Changes can be staged by calls to `rcs_add`, `rcs_remove`, and |