]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - IkiWiki/Rcs/Stub.pm
Fix link from meta plugin to tips/howto_stop_flooding_aggregators
[git.ikiwiki.info.git] / IkiWiki / Rcs / Stub.pm
index 19ecfa88df571bd2ca4553c4c9bbc0690ba12188..6b69e65dcdbc2e92ff5e8e725830f4626c6c6a4d 100644 (file)
@@ -1,12 +1,12 @@
 #!/usr/bin/perl
 # Stubs for no revision control.
 
+package 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.)
@@ -37,6 +37,7 @@ 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,
@@ -56,11 +57,11 @@ 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_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 ($) {