]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Rcs/Stub.pm
stylistic changes
[ikiwiki.git] / IkiWiki / Rcs / Stub.pm
index e408d5ac3c975e0c8409af513f4cd5310bc6bbf4..df347f6a994711977fd2f88c10393c53406d14b5 100644 (file)
@@ -20,7 +20,7 @@ sub rcs_prepedit ($) {
        return ""
 }
 
        return ""
 }
 
-sub rcs_commit ($$$) {
+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.
        # 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.
@@ -29,12 +29,15 @@ sub rcs_commit ($$$) {
 
 sub rcs_add ($) {
        # Add a file. The filename is relative to the root of the srcdir.
 
 sub rcs_add ($) {
        # Add a file. The filename is relative to the root of the srcdir.
+       # Note that this should not check the new file in, it should only
+       # prepare for it to be checked in when rcs_commit is called.
 }
 
 sub rcs_recentchanges ($) {
        # Examine the RCS history and generate a list of recent changes.
        # The data structure returned for each change is:
        # {
 }
 
 sub rcs_recentchanges ($) {
        # Examine the RCS history and generate a list of recent changes.
        # The data structure returned for each change is:
        # {
+       #       rev => # the RCSs id for this commit
        #       user => # name of user who made the change,
        #       committype => # either "web" or the name of the rcs,
        #       when => # time when the change was made,
        #       user => # name of user who made the change,
        #       committype => # either "web" or the name of the rcs,
        #       when => # time when the change was made,
@@ -54,16 +57,9 @@ sub rcs_recentchanges ($) {
        # }
 }
 
        # }
 }
 
-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 ($) {
        # Optional, used to get the page creation time from the RCS.
 sub rcs_getctime ($) {
        # Optional, used to get the page creation time from the RCS.
-       error "getctime not implemented";
+       error gettext("getctime not implemented");
 }
 
 1
 }
 
 1