]> sipb.mit.edu Git - ikiwiki.git/blobdiff - IkiWiki/Rcs/Stub.pm
git: Fix parsing of git logs with no commit messages at all.
[ikiwiki.git] / IkiWiki / Rcs / Stub.pm
index 01696a8b0a25b4d34282be0bc6e8307a8fe72dbe..6b69e65dcdbc2e92ff5e8e725830f4626c6c6a4d 100644 (file)
@@ -1,12 +1,12 @@
 #!/usr/bin/perl
 # Stubs for no revision control.
 
 #!/usr/bin/perl
 # Stubs for no revision control.
 
+package IkiWiki;
+
 use warnings;
 use strict;
 use IkiWiki;
 
 use warnings;
 use strict;
 use IkiWiki;
 
-package IkiWiki;
-
 sub rcs_update () {
        # Update working directory to current version.
        # (May be more complex for distributed RCS.)
 sub rcs_update () {
        # Update working directory to current version.
        # (May be more complex for distributed RCS.)
@@ -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,41 +29,44 @@ 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,
        #       message => [
        #       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 => [
-       #               "commit message line",
-       #               "commit message line",
-       #               "...",
+       #               { line => "commit message line" },
+       #               { line => "commit message line" },
+       #               # etc,
        #       ],
        #       pages => [
        #               {
        #                       page => # name of page changed,
        #                       diffurl => # optional url to a diff showing 
        #                                  # the changes,
        #       ],
        #       pages => [
        #               {
        #                       page => # name of page changed,
        #                       diffurl => # optional url to a diff showing 
        #                                  # the changes,
-       #               }
-       #               # repeat for each page changed in this commit
+       #               },
+       #               # 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_diff ($) {
+       # Optional, used to get diffs for recentchanges.
+       # The parameter is the rev from rcs_recentchanges.
+       # Should return a list of lines of the diff (including \n) in list
+       # context, and the whole diff in scalar context.
 }
 
 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