* Remove locking code in git rcs_commit. I'm not sure if this was ever

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

diff --git a/IkiWiki/Rcs/Stub.pm b/IkiWiki/Rcs/Stub.pm
index 03757758aa2fc3815223430848b8bfac9bdd8fcc..d94daf8bc9522b31db221c162bab410a5e16a2ed 100644 (file)
--- a/IkiWiki/Rcs/Stub.pm
+++ b/IkiWiki/Rcs/Stub.pm
@@ -29,12 +29,15 @@ sub rcs_commit ($$$;$$) {
 
 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:
        # {
+       #       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,
@@ -54,11 +57,10 @@ 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.
+       return "";
 }
 
 sub rcs_getctime ($) {