diff options
| author | Joey Hess <joey@kitenet.net> | 2010-06-23 16:05:49 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2010-06-23 16:05:49 -0400 |
| commit | b4a43406f61b7ff9ab77d242edf4d59369ac8596 (patch) | |
| tree | ca0d33b7d0e22a19f9fb1610df1f7238bcd2ec3d /doc/plugins | |
| parent | c46bcb425af0948ac59581d6ba7b477826d83ae3 (diff) | |
| download | ikiwiki-b4a43406f61b7ff9ab77d242edf4d59369ac8596.tar ikiwiki-b4a43406f61b7ff9ab77d242edf4d59369ac8596.tar.gz | |
API: rcs_commit and rcs_commit_staged are passed a new parameter
that may contain the username component of the email address of
the user making the commit.
Diffstat (limited to 'doc/plugins')
| -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 |