NAME

SVK::Log::ChangedPath - changes made to a path during in a revision

SYNOPSIS

    print "Path of change : ", $changed_path->path(), "\n";
    print "Action         : ", $changed_path->action(), "\n";
    print "Property action: ", $changed_path->property_action(), "\n";
    ...

DESCRIPTION

An object of this class represents a path which was modified in a particular revision. It provides methods to determine how the path was modified. This class is intended for indirect use by log filters. Log filters may want to report about the paths that were modified during a particular revision, but they shouldn't have to know the details of how SVK determines those changes. Encapsulating that knowledge in this class allows log filters to focus on formatting, displaying and analyzing the logs.

METHODS

new $root, $path_name, $path_entry

SVK::Log::ChangedPath objects are usually created from SVK::Log::ChangedPaths and it's probably meaningless to construct them anywhere else. Nevertheless, here's a brief description.

$root should be the return value from SVK::Path->root() $path_name is the key in the hash returned by $root->paths_changed() $path_entry is the corresponding value from that hash.

action

Returns a single character indicating the way in which the content of the path was changed. This letter is the same as the first column in the path line that you see when you do svk log --verbose

copied_from

If the path was copied from somewhere else in this revision, copied_from() returns the revision and path from which this path was copied. The values are returned as a list with items in that order. Namely,

 if ( $changed_path->is_copy() ) {
    my ($rev, $path) = $changed_path->copied_from();
    print "Copied from $path in revision $rev\n";
 }

is_copy

Returns true if the path was copied from somewhere else in this revision, otherwise, returns false.

path

Returns the full depot path for this changed path.

property_action

Returns a single character indicating the way in which the properties of the path were changed. This letter is the same as the second column in the path line that you see when you do svk log --verbose

DIAGNOSTICS

None

CONFIGURATION AND ENVIRONMENT

SVK::Log::ChangedPath requires no configuration files or environment variables.

DEPENDENCIES

  • SVK::Command::Log

INCOMPATIBILITIES

None known.

BUGS AND LIMITATIONS

None known.