SVN::Web::Log(3pm) User Contributed Perl Documentation SVN::Web::Log(3pm)NAME
SVN::Web::Log - SVN::Web action to show log messages for a repository path
SYNOPSIS
In config.yaml
actions:
...
log:
class: SVN::Web::Log
action_menu:
show:
- file
- directory
link_text: (view revision log)
...
DESCRIPTION
Shows log messages (in reverse order) for interesting revisions of a given file or directory in the repository.
OPTIONS
limit The number of log entries to retrieve. The default is 20.
rev The repository revision to start with. The default is the repository's youngest revision.
TEMPLATE VARIABLES
context Either "directory" or "file".
at_head A boolean value, true if the log starts with the most recent revision.
at_oldest
A boolean value, true if the list of revisions ("revs") includes the oldest revision for this path.
isdir A boolean value, true if the given path is a directory.
rev The repository revision that the log starts with.
revs A list of hashes. Each entry corresponds to a particular repository revision, and has the following keys.
rev The repository revision this entry is for.
youngest_rev
The repository's youngest revision.
author The author of this change.
date The date of this change, formatted according to "Time and date formatting" in SVN::Web.
msg The log message for this change.
paths A list of hashes containing information about the paths that were changed with this commit. Each hash key is the path name
that was modified with this commit. Each key is a hash ref of extra information about the change to this path. These hash
refs have the following keys.
action A single letter indicating the action that was carried out on the path. A file was either added "A", modified "M",
replaced "R", or deleted "D".
copyfrom
If the file was copied from another file then this is the path of the source of the copy.
copyfromrev
If the file was copied from another file then this is the revision of the file that it was copied from.
limit The value of the "limit" parameter.
EXCEPTIONS
None.
COPYRIGHT
Copyright 2003-2004 by Chia-liang Kao "<clkao@clkao.org>".
Copyright 2005-2007 by Nik Clayton "<nik@FreeBSD.org>".
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See <http://www.perl.com/perl/misc/Artistic.html>
perl v5.14.2 2012-06-11 SVN::Web::Log(3pm)
Check Out this Related Man Page
SVN::Web::X(3pm) User Contributed Perl Documentation SVN::Web::X(3pm)NAME
SVN::Web::X - exceptions for SVN::Web
SYNOPSIS
use SVN::Web::X;
...
SVN::Web::X->throw(error => '(error message %1)',
vars => [$var_to_interpolate]);
DESCRIPTION
SVN::Web::X implements exceptions for SVN::Web. Derived from Exception::Class, It provides a simple mechanism for throwing exceptions,
catching them, and ensuring that friendly, localised error messages are generated and sent to the user's browser.
USAGE IN SVN ::Web ACTIONS
If an SVN::Web action that you are writing needs to stop processing and raise an error, throw an SVN::Web::X exception.
"throw()" takes a hash with two mandatory keys.
"error"
A string describing the error. This string should be short, and key to a longer internationalised message.
This string may contain placeholders; %1, %2, %3, and so on. These will be replaced by the values of the variables passed in the
"vars" key.
By convention this string should be enclosed in parentheses, "(" and ")". This helps make them stand out in the interface, if
localised versions of the error message have not yet been written.
"vars"
An array reference. The first entry in the array will replace the %1 placeholder in "error", the second entry will replace the %2
placeholder, and so on.
If there are no placeholders then pass a reference to an empty array.
EXAMPLES
A simple exception, with no placeholders.
In the action:
sub run {
...
if(! frob_repo()) {
SVN::Web::X->throw(error => '(frob failed)',
vars => []);
}
...
}
In the en.po file for the localised text.
msgid "(frob failed)"
msgstr "There was a problem trying to frob the repository. This "
"probably indicates a permissions problem."
An exception with placeholders
In the action:
sub run {
...
# $path is a repo path, $rev is a repo revision
my $root = $fs->revision_root($rev);
my $kind = $root->check_path($path);
if($kind == $SVN::Node::none) {
SVN::Web::X->throw(error => '(path %1 does not exist in rev %2)',
vars => [$path, $rev]);
}
}
In the en.po file for the localised text.
msgid "(path %1 does not exist in rev %2)"
msgstr "The path <tt>%1</tt> could not be found in the repository "
"at revision %2. This may be a typo in the path or the revision "
"number. SVN::Web should never normally generate a link like this. "
"If you followed a link from SVN::Web (rather than from an e-mail,
"or similar) please report this as a bug."
As you can see, the localised text can be much friendlier and more informative to the user than the error message.
COPYRIGHT
Copyright 2003-2004 by Chia-liang Kao "<clkao@clkao.org>".
Copyright 2005-2007 by Nik Clayton "<nik@FreeBSD.org>".
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See <http://www.perl.com/perl/misc/Artistic.html>
perl v5.14.2 2012-06-11 SVN::Web::X(3pm)