git: Put web committer name/openid/address in the git author field

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

diff --git a/IkiWiki/Rcs/Stub.pm b/IkiWiki/Rcs/Stub.pm
index 15e6cfb480db22c59d1dd8cc47a3994f7e1b1455..6b69e65dcdbc2e92ff5e8e725830f4626c6c6a4d 100644 (file)
--- a/IkiWiki/Rcs/Stub.pm
+++ b/IkiWiki/Rcs/Stub.pm
@@ -1,34 +1,72 @@
 #!/usr/bin/perl
 # Stubs for no revision control.
 
 #!/usr/bin/perl
 # Stubs for no revision control.
 

+package IkiWiki;
+

 use warnings;
 use strict;
 use IkiWiki;
 
 use warnings;
 use strict;
 use IkiWiki;
 

-package IkiWiki;
-

 sub rcs_update () {
 sub rcs_update () {

+       # Update working directory to current version.
+       # (May be more complex for distributed RCS.)

 }
 
 sub rcs_prepedit ($) {
 }
 
 sub rcs_prepedit ($) {

+       # Prepares to edit a file under revision control. Returns a token
+       # that must be passed into rcs_commit when the file is ready
+       # for committing.
+       # The file is relative to the srcdir.

        return ""
 }
 
        return ""
 }
 

-sub rcs_commit ($$$) {
+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.

        return undef # success
 }
 
 sub rcs_add ($) {
        return undef # success
 }
 
 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 ($) {
 }
 
 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,
+       #       message => [
+       #               { line => "commit message line" },
+       #               { line => "commit message line" },
+       #               # etc,
+       #       ],
+       #       pages => [
+       #               {
+       #                       page => # name of page changed,
+       #                       diffurl => # optional url to a diff showing 
+       #                                  # the changes,
+       #               },
+       #               # repeat for each page changed in this commit,
+       #       ],
+       # }

 }
 
 }
 

-sub rcs_notify () {
+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 () {
-       error "getctime not implemented";
+sub rcs_getctime ($) {
+       # Optional, used to get the page creation time from the RCS.
+       error gettext("getctime not implemented");

 }
 
 1
 }
 
 1