.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "SVN::Web::Revision 3pm" .TH SVN::Web::Revision 3pm "2016-11-12" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" SVN::Web::Revision \- SVN::Web action to view a repository revision .SH "SYNOPSIS" .IX Header "SYNOPSIS" In \fIconfig.yaml\fR .PP .Vb 8 \& actions: \& ... \& revision: \& class: SVN::Web::Revision \& opts: \& max_diff_size: 200_000 \& show_diff: 1 # or 0 \& ... .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Shows information about a specific revision in a Subversion repository. .SH "CONFIGURATION" .IX Header "CONFIGURATION" The following configuration options may be specified in \fIconfig.yaml\fR. .IP "max_diff_size" 4 .IX Item "max_diff_size" If showing the diff (see \f(CW\*(C`show_diff\*(C'\fR), 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. .Sp Defaults to 200,000 bytes. .IP "show_diff" 4 .IX Item "show_diff" Boolean indicating whether or not a diff of every file that was changed in the revision should be shown. .Sp Defaults to 1. .SH "OPTIONS" .IX Header "OPTIONS" .IP "rev" 8 .IX Item "rev" The revision to show. If not provided then use the repository's youngest revision. .SH "TEMPLATE VARIABLES" .IX Header "TEMPLATE VARIABLES" .IP "context" 8 .IX Item "context" Always \f(CW\*(C`revision\*(C'\fR. .IP "rev" 8 .IX Item "rev" The revision that is being shown. .IP "youngest_rev" 8 .IX Item "youngest_rev" The repository's youngest revision. This is useful when constructing \&\f(CW\*(C`next revision\*(C'\fR and \f(CW\*(C`previous revision\*(C'\fR links. .IP "date" 8 .IX Item "date" The date on which the revision was committed, formatted according to \&\*(L"Time and date formatting\*(R" in SVN::Web. .IP "author" 8 .IX Item "author" The revision's author. .IP "msg" 8 .IX Item "msg" The log message associated with this revision. .IP "paths" 8 .IX Item "paths" A hash of hash refs. Each key is a path name. The value is a further hash ref with the following keys. .RS 8 .IP "isdir" 8 .IX Item "isdir" A boolean value, true if the given path is a directory. .IP "diff" 8 .IX Item "diff" A SVN::Web::DiffParser object representing the diff. This may be undef, if the generated diff was larger than \f(CW\*(C`max_diff_size\*(C'\fR or if \f(CW\*(C`show_diff\*(C'\fR is false. .IP "diff_size" 8 .IX Item "diff_size" The size of the generated diff (before parsing). .IP "max_diff_size" 8 .IX Item "max_diff_size" The configured maximum diff size. .IP "action" 8 .IX Item "action" A single letter indicating the action that carried out on the path. A file was either added \f(CW\*(C`A\*(C'\fR, modified \f(CW\*(C`M\*(C'\fR, replaced \f(CW\*(C`R\*(C'\fR, or deleted \&\f(CW\*(C`D\*(C'\fR. .IP "copyfrom" 8 .IX Item "copyfrom" If the file was copied from another file then this is the path of the source of the copy. .IP "copyfromrev" 8 .IX Item "copyfromrev" If the file was copied from another file then this is the revision of the file that it was copied form. .RE .RS 8 .RE .SH "EXCEPTIONS" .IX Header "EXCEPTIONS" .ie n .IP "(revision %1 does not exist)" 4 .el .IP "(revision \f(CW%1\fR does not exist)" 4 .IX Item "(revision %1 does not exist)" The given revision does not exist in the repository. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2003\-2004 by Chia-liang Kao \f(CW\*(C`\*(C'\fR. .PP Copyright 2005\-2007 by Nik Clayton \f(CW\*(C`\*(C'\fR. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See