SVK::Log::FilterPipeline(3) User Contributed Perl Documentation SVK::Log::FilterPipeline(3)NAME
SVK::Log::FilterPipeline - a pipeline of log filter objects
DESCRIPTION
An SVK::Log::FilterPipeline represents a particular collection of log filter objects each of which needs to be called in turn.
METHODS
new
Construct a new SVK::Log::FilterPipeline object by constructing the specific filters that will handle the details and preparing for the
first revision.
build_filter_object
Given the name of a filter, try and construct an appropriate filter object. Search @INC for modules that match the name given. If no
appropriate classes are available, we die with an appropriate warning.
This method creates an object for the filter by calling its new() method
filter
SVK::Command::Log calls this routine when it wants to display (or process) a revision. The method then dispatches the information to the
methods of the necessary filter objects in the pipeline to perform the real work.
finished
Tell all the filters that their jobs are done by calling "footer" and "teardown" on each one.
get_pipeline_command
Examine an exception to determine if it's a pipeline control exception. If it is, return the desired pipeline command. If it's not,
rethrow the exception. If no exception is provided, the command 'continue' is returned.
present_revision
Display a single revision by passing it to the pipeline's presentation filter.
run_pipeline
Send a revision down the pipeline. Provide revision information to the revision() method of each filter in the pipeline until one of them
says to stop. Then return the pipeline command.
set_up_presentation
Handle initial set up for the presentation filter. This should only be called once during an SVK::Log::FilterPipeline's lifetime.
set_up_selection
Handle initial set up for the selection filter pipeline. This should only be called once during "SVK::Log::FilterPipeline"'s lifetime.
split_filter
Split a string into a filter name and an arbitrary argument string.
split_selectors
Split the description of the selection filter pipeline into individual filter names and their arguments. Each filter is separated by a '|'
character. Literal pipe characters are included with '|'.
perl v5.10.0 2008-08-04 SVK::Log::FilterPipeline(3)
Check Out this Related Man Page
SVK::Log::ChangedPath(3) User Contributed Perl Documentation SVK::Log::ChangedPath(3)NAME
SVK::Log::ChangedPath - changes made to a path during in a revision
SYNOPSIS
print "Path of change : ", $changed_path->path(), "
";
print "Action : ", $changed_path->action(), "
";
print "Property action: ", $changed_path->property_action(), "
";
...
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
";
}
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
o SVK::Command::Log
INCOMPATIBILITIES
None known.
BUGS AND LIMITATIONS
None known.
perl v5.10.0 2008-08-04 SVK::Log::ChangedPath(3)