]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Rcs/Stub.pm
update
[ikiwiki.git] / IkiWiki / Rcs / Stub.pm
index 15e6cfb480db22c59d1dd8cc47a3994f7e1b1455..e408d5ac3c975e0c8409af513f4cd5310bc6bbf4 100644 (file)
@@ -8,26 +8,61 @@ use IkiWiki;
 package IkiWiki;
 
 sub rcs_update () {
+       # Update working directory to current version.
+       # (May be more complex for distributed RCS.)
 }
 
 sub rcs_prepedit ($) {
+       # Prepares to edit a file under revision control. Returns a token
+       # that must be passed into rcs_commit when the file is ready
+       # for committing.
+       # The file is relative to the srcdir.
        return ""
 }
 
 sub rcs_commit ($$$) {
+       # Tries to commit the page; returns undef on _success_ and
+       # a version of the page with the rcs's conflict markers on failure.
+       # The file is relative to the srcdir.
        return undef # success
 }
 
 sub rcs_add ($) {
+       # Add a file. The filename is relative to the root of the srcdir.
 }
 
 sub rcs_recentchanges ($) {
+       # Examine the RCS history and generate a list of recent changes.
+       # The data structure returned for each change is:
+       # {
+       #       user => # name of user who made the change,
+       #       committype => # either "web" or the name of the rcs,
+       #       when => # time when the change was made,
+       #       message => [
+       #               { line => "commit message line" },
+       #               { line => "commit message line" },
+       #               # etc,
+       #       ],
+       #       pages => [
+       #               {
+       #                       page => # name of page changed,
+       #                       diffurl => # optional url to a diff showing 
+       #                                  # the changes,
+       #               },
+       #               # repeat for each page changed in this commit,
+       #       ],
+       # }
 }
 
 sub rcs_notify () {
+       # This function is called when a change is committed to the wiki,
+       # and ikiwiki is running as a post-commit hook from the RCS.
+       # It should examine the repository to somehow determine what pages
+       # changed, and then send emails to users subscribed to those pages.
 }
 
-sub rcs_getctime () {
+sub rcs_getctime ($) {
+       # Optional, used to get the page creation time from the RCS.
        error "getctime not implemented";
 }