svn::web::x(3pm) [debian 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)
Check Out this Related Man Page
SVN::Web::Diff(3pm) User Contributed Perl Documentation SVN::Web::Diff(3pm) NAME
SVN::Web::Diff - SVN::Web action to show differences between file revisions SYNOPSIS
In config.yaml actions: ... diff: class: SVN::Web::Diff ... DESCRIPTION
Returns the difference between two revisions of the same file. CONFIGURATION
The following configuration options may be specified in config.yaml. max_diff_size If showing the diff (see "show_diff"), this determines the maximum size of the diff that will be shown. If the size of the generated diff (in bytes) is larger than this figure then it is not shown. Defaults to 200,000 bytes. OPTIONS
rev1 The first revision of the file to compare. rev2 The second revision of the file to compare. revs A list of two or more revisions. If present, the smallest number in the list is assigned to "rev1" (overriding any given "rev1" value) and the largest number in the list is assigned to "rev2" (overriding any given "rev2" value). In other words: ...?rev1=5;rev2=10 is equal to: ...?revs=10;revs=5 This supports the "diff between arbitrary revisions" functionality. mime The desired output format. The default is "html" for a diff marked up in HTML. The other allowed value is "text", for a plain text unified diff. TEMPLATE VARIABLES
at_head Boolean, indicating whether or not we're currently diffing against the youngest revision of this file. context Always "file". rev1 The first revision of the file to compare. Corresponds with the "rev1" parameter, either set explicitly, or extracted from "revs". rev2 The second revision of the file to compare. Corresponds with the "rev2" parameter, either set explicitly, or extracted from "revs". diff An SVN::Web::DiffParser object that contains the text of the diff. Call the object's methods to format the diff. diff_size The size of the generated diff (before parsing). max_diff_size The configured maximum diff size. EXCEPTIONS
(cannot diff nodes of different types: %1 %2 %3) The given path has different node types at the different revisions. This probably means a file was added, deleted, and then re-added as a directory at a later date (or vice-versa). (path %1 is a directory at rev %2) The user has tried to diff two directories. This is not currently supported. (path %1 does not exist in revision %2) The given path is not present in the repository at the given revision. (two revisions must be provided) No revisions were given to diff against. (rev1 and rev2 must be different) Either only one revision number was given, or several were given, but they're the same number. 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::Diff(3pm)