ikiwiki/IkiWiki/Rcs/Stub.pm

72 lines
1.9 KiB
Perl
Raw Normal View History

2006-03-26 04:30:44 +02:00
#!/usr/bin/perl
# Stubs for no revision control.
use warnings;
use strict;
use IkiWiki;
package IkiWiki;
sub rcs_update () {
2006-09-03 19:14:27 +02:00
# Update working directory to current version.
# (May be more complex for distributed RCS.)
}
sub rcs_prepedit ($) {
2006-09-03 19:14:27 +02:00
# 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 ""
}
2006-11-22 15:28:38 +01:00
sub rcs_commit ($$$;$$) {
2006-09-03 19:14:27 +02:00
# 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 ($) {
2006-09-03 19:14:27 +02:00
# 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 ($) {
# Examine the RCS history and generate a list of recent changes.
# The data structure returned for each change is:
# {
# 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 => [
2006-09-04 06:25:34 +02:00
# { line => "commit message line" },
# { line => "commit message line" },
# # etc,
# ],
# pages => [
# {
# page => # name of page changed,
# diffurl => # optional url to a diff showing
# # the changes,
2006-09-04 06:32:32 +02:00
# },
# # repeat for each page changed in this commit,
# ],
# }
}
2006-04-25 01:09:26 +02:00
sub rcs_notify () {
2006-09-03 19:14:27 +02:00
# 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.
2006-04-25 01:09:26 +02:00
}
sub rcs_getctime ($) {
2006-09-03 19:14:27 +02:00
# Optional, used to get the page creation time from the RCS.
error gettext("getctime not implemented");
2006-03-26 04:30:44 +02:00
}
1