* Avoid using commands like git-diff and instead use "git diff".
[ikiwiki.git] / IkiWiki / Rcs / Stub.pm
1 #!/usr/bin/perl
2 # Stubs for no revision control.
3
4 use warnings;
5 use strict;
6 use IkiWiki;
7
8 package IkiWiki;
9
10 sub rcs_update () {
11         # Update working directory to current version.
12         # (May be more complex for distributed RCS.)
13 }
14
15 sub rcs_prepedit ($) {
16         # Prepares to edit a file under revision control. Returns a token
17         # that must be passed into rcs_commit when the file is ready
18         # for committing.
19         # The file is relative to the srcdir.
20         return ""
21 }
22
23 sub rcs_commit ($$$;$$) {
24         # Tries to commit the page; returns undef on _success_ and
25         # a version of the page with the rcs's conflict markers on failure.
26         # The file is relative to the srcdir.
27         return undef # success
28 }
29
30 sub rcs_add ($) {
31         # Add a file. The filename is relative to the root of the srcdir.
32         # Note that this should not check the new file in, it should only
33         # prepare for it to be checked in when rcs_commit is called.
34 }
35
36 sub rcs_recentchanges ($) {
37         # Examine the RCS history and generate a list of recent changes.
38         # The data structure returned for each change is:
39         # {
40         #       user => # name of user who made the change,
41         #       committype => # either "web" or the name of the rcs,
42         #       when => # time when the change was made,
43         #       message => [
44         #               { line => "commit message line" },
45         #               { line => "commit message line" },
46         #               # etc,
47         #       ],
48         #       pages => [
49         #               {
50         #                       page => # name of page changed,
51         #                       diffurl => # optional url to a diff showing 
52         #                                  # the changes,
53         #               },
54         #               # repeat for each page changed in this commit,
55         #       ],
56         # }
57 }
58
59 sub rcs_notify () {
60         # This function is called when a change is committed to the wiki,
61         # and ikiwiki is running as a post-commit hook from the RCS.
62         # It should examine the repository to somehow determine what pages
63         # changed, and then send emails to users subscribed to those pages.
64 }
65
66 sub rcs_getctime ($) {
67         # Optional, used to get the page creation time from the RCS.
68         error gettext("getctime not implemented");
69 }
70
71 1