Merge branch 'master' into xapian

[ikiwiki.git] / IkiWiki / Rcs / Stub.pm

diff --git a/IkiWiki/Rcs/Stub.pm b/IkiWiki/Rcs/Stub.pm
index a979ce3fe6036ed956cd0b8fcecec3e85cd9f129..a460f29a2ee34f9580ba9ad5a81c3b2159a32acf 100644 (file)
--- a/IkiWiki/Rcs/Stub.pm
+++ b/IkiWiki/Rcs/Stub.pm
@@ -37,7 +37,7 @@ sub rcs_recentchanges ($) {
        # Examine the RCS history and generate a list of recent changes.
        # The data structure returned for each change is:
        # {
-       #       id => # the RCSs id for this commit
+       #       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,
@@ -57,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 ($) {