po: add comments

[git.ikiwiki.info.git] / IkiWiki / Plugin / norcs.pm

diff --git a/IkiWiki/Plugin/norcs.pm b/IkiWiki/Plugin/norcs.pm
index 04ba5f028dc76e2d0eff76a6137db4d50e5eeea3..58c26b63350b5ccc1540d7815ee78d0e8f2ab7cc 100644 (file)
--- a/IkiWiki/Plugin/norcs.pm
+++ b/IkiWiki/Plugin/norcs.pm
@@ -1,99 +1,68 @@
 #!/usr/bin/perl
 # Stubs for no revision control.
 #!/usr/bin/perl
 # Stubs for no revision control.

-
-package IkiWiki;
+package IkiWiki::Plugin::norcs;

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

-sub rcs_update () {
-       # Update working directory to current version.
-       # (May be more complex for distributed RCS.)
-}
+sub import { #{{{
+       hook(type => "getsetup", id => "norcs", call => \&getsetup);
+       hook(type => "rcs", id => "rcs_update", call => \&rcs_update);
+       hook(type => "rcs", id => "rcs_prepedit", call => \&rcs_prepedit);
+       hook(type => "rcs", id => "rcs_commit", call => \&rcs_commit);
+       hook(type => "rcs", id => "rcs_commit_staged", call => \&rcs_commit_staged);
+       hook(type => "rcs", id => "rcs_add", call => \&rcs_add);
+       hook(type => "rcs", id => "rcs_remove", call => \&rcs_remove);
+       hook(type => "rcs", id => "rcs_rename", call => \&rcs_rename);
+       hook(type => "rcs", id => "rcs_recentchanges", call => \&rcs_recentchanges);
+       hook(type => "rcs", id => "rcs_diff", call => \&rcs_diff);
+       hook(type => "rcs", id => "rcs_getctime", call => \&rcs_getctime);
+} #}}}
+
+sub getsetup () { #{{{
+       return
+               plugin => {
+                       safe => 0, # rcs plugin
+                       rebuild => 0,
+               },
+} #}}}
+
+
+sub rcs_update () { #{{{
+} #}}}

 
 

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

        return ""
        return ""

-}
+} #}}}

 
 

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

        my ($file, $message, $rcstoken, $user, $ipaddr) = @_;
        return undef # success
        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.
+sub rcs_commit_staged ($$$) { #{{{

        my ($message, $user, $ipaddr)=@_;
        return undef # success
        my ($message, $user, $ipaddr)=@_;
        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.
-       # 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_add ($) { #{{{
+} #}}}

 
 

-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_remove ($) { #{{{
+} #}}}

 
 

-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_rename ($$) { #{{{
+} #}}}

 
 

-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_recentchanges ($) { #{{{
+} #}}}

 
 

-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_diff ($) { #{{{
+} #}}}

 
 

-sub rcs_getctime ($) {
-       # Optional, used to get the page creation time from the RCS.
+sub rcs_getctime ($) { #{{{

        error gettext("getctime not implemented");
        error gettext("getctime not implemented");

-}
+} #}}}

 
 1
 
 1