Support staging commands in bzr backend.

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

diff --git a/IkiWiki/Rcs/Stub.pm b/IkiWiki/Rcs/Stub.pm
index a979ce3fe6036ed956cd0b8fcecec3e85cd9f129..04ba5f028dc76e2d0eff76a6137db4d50e5eeea3 100644 (file)
--- 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.)
@@ -24,6 +24,14 @@ 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.
+       my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
+       return undef # success
+}
+
+sub rcs_commit_staged ($$$) {
+       # Commits all staged changes. Changes can be staged using rcs_add,
+       # rcs_remove, and rcs_rename.
+       my ($message, $user, $ipaddr)=@_;
        return undef # success
 }
 
@@ -31,13 +39,32 @@ 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.
+       # Note that the file may be in a new subdir that is not yet added
+       # to version control; the subdir can be added if so.
+}
+
+sub rcs_remove ($) {
+       # Remove a file. The filename is relative to the root of the srcdir.
+       # Note that this should not check the removal in, it should only
+       # prepare for it to be checked in when rcs_commit is called.
+       # Note that the new file may be in a new subdir that is not yet added
+       # to version control; the subdir can be added if so.
+}
+
+sub rcs_rename ($$) {
+       # Rename a file. The filenames are relative to the root of the srcdir.
+       # Note that this should not commit the rename, it should only
+       # prepare it for when rcs_commit is called.
+       # The new filename may be in a new subdir, that is not yet added to
+       # version control. If so, the subdir will exist already, and should
+       # be added to revision control.
 }
 
 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 +84,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 ($) {