]> sipb.mit.edu Git - ikiwiki.git/blob - IkiWiki/Rcs/Stub.pm
ffd9e18650d7effc87e17e4c02e3fd4d9fe24a6d
[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 }
33
34 sub rcs_recentchanges ($) {
35         # Examine the RCS history and generate a data structure for
36         # the recentchanges page.
37         # This structure is a list of items, each item is a hash reference
38         # representing one change to the repo.
39         # The hash has keys user (a link to the user making the change),
40         # committype (web or the name of the rcs), when (when the change
41         # happened, relative to the current time), message (a reference
42         # to an array of lines for the commit message), and pages (a
43         # reference to an array of links to the pages that were changed).
44 }
45
46 sub rcs_notify () {
47         # This function is called when a change is committed to the wiki,
48         # and ikiwiki is running as a post-commit hook from the RCS.
49         # It should examine the repository to somehow determine what pages
50         # changed, and then send emails to users subscribed to those pages.
51 }
52
53 sub rcs_getctime ($) {
54         # Optional, used to get the page creation time from the RCS.
55         error "getctime not implemented";
56 }
57
58 1