Dean Hamstead > SVN-Web-0.61 > SVN::Web::Revision

Download:
SVN-Web-0.61.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  6
View/Report Bugs
Module Version: 0.53   Source   Latest Release: SVN-Web-0.63

NAME ^

SVN::Web::Revision - SVN::Web action to view a repository revision

SYNOPSIS ^

In config.yaml

  actions:
    ...
    revision:
      class: SVN::Web::Revision
      opts:
        max_diff_size: 200_000
        show_diff: 1 # or 0
    ...

DESCRIPTION ^

Shows information about a specific revision in a Subversion repository.

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.

show_diff

Boolean indicating whether or not a diff of every file that was changed in the revision should be shown.

Defaults to 1.

OPTIONS ^

rev

The revision to show. If not provided then use the repository's youngest revision.

TEMPLATE VARIABLES ^

context

Always revision.

rev

The revision that is being shown.

youngest_rev

The repository's youngest revision. This is useful when constructing next revision and previous revision links.

date

The date on which the revision was committed, formatted according to "Time and date formatting" in SVN::Web.

author

The revision's author.

msg

The log message associated with this revision.

paths

A hash of hash refs. Each key is a path name. The value is a further hash ref with the following keys.

isdir

A boolean value, true if the given path is a directory.

diff

A SVN::Web::DiffParser object representing the diff. This may be undef, if the generated diff was larger than max_diff_size or if show_diff is false.

diff_size

The size of the generated diff (before parsing).

max_diff_size

The configured maximum diff size.

action

A single letter indicating the action that 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 form.

EXCEPTIONS ^

(revision %1 does not exist)

The given revision does not exist in the repository.

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

syntax highlighting: