X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/912521ef0711204965aa2319d41c7741bd3f4f4c..35668b87d3247a7de6c4dbb9edd7e0d909603524:/IkiWiki/Rcs/Stub.pm

diff --git a/IkiWiki/Rcs/Stub.pm b/IkiWiki/Rcs/Stub.pm
index 03757758a..6b69e65dc 100644
--- a/IkiWiki/Rcs/Stub.pm
+++ b/IkiWiki/Rcs/Stub.pm
@@ -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.)
@@ -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,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 ($) {