VCP::Dest - A base class for VCP destinations
Creates an instance, see subclasses for options. The options passed are usually native command-line options for the underlying repository's client. These are usually parsed and, perhaps, checked for validity by calling the underlying command line.
This class uses the fields pragma, so you'll need to use base and possibly fields in any subclasses.
These methods are intended to support subclasses.
Gets/sets the $header passed to handle_header().
Generally not overridden: all error checking is done in new(), and no output should be generated until output() is called.
These methods are overloaded by subclasses.
$dest->backfill( $rev ) ;
Checks the file indicated by VCP::Rev $rev out of the target repository if this destination supports backfilling. Currently, only the revml destination does not support backfilling.
The $rev->{workpath} must be set to the filename the backfill was put in.
This is used when doing an incremental update, where the first revision of a file in the update is encoded as a delta from the prior version. A digest of the prior version is sent along before the first version delta to verify it's presence in the database.
So, the source calls backfill(), which returns TRUE on success, FALSE if the destination doesn't support backfilling, and dies if there's an error in procuring the right revision.
If FALSE is returned, then the revisions will be sent through with no working path, but will have a delta record.
MUST BE OVERRIDDEN.
$dest->handle_footer( $footer ) ;
Does any cleanup necessary. Not required. Don't call this from the override.
$dest->handle_header( $header ) ;
Stows $header in $self->header. This should only rarely be overridden, since the first call to handle_rev() should output any header info.
Returns a subroutine reference to a sorting function. See "sort".
Returns -1, 0, or 1 depending on the relative order between $rev_a and $rev_b. This may be overridded.
Default ordering is by
- change_id (compared numerically using <=>, for now) - time (commit time: simple numeric, since this is a simple number) - comment (alphabetically, case sensitive) - name (path-component-wise alphabetically case sensitive)
This ordering benefits change number oriented systems while preserving commit order for non-change number oriented systems.
If change_id is undefined in either rev, it is not used.
If time is undefined in a rev, the value "-1" is used. This causes base revisions (ie digest-only) to precede real revisions.
That's not always good, though: one of commit time or change number should be defined!
Change ids are compared numerically, times by date order (ie by alphabetic, since ISO8601 dates are used internally). Comment is compared alphabetically, and name is compared piecewise alphabetically after splitting both names on '/' ('//', '///', etc, are treated like '/').
This will confess a problem if none of the above are defined, since I can't think of any other rational sorting basis in the general case.
$source->dest->sort_revs( $source->revs ) ;
This sorts the revisions that the source has identified in to whatever order is needed by the destination. The default ordering is set by "rev_cmp_sub".
$dest->handle_rev( $rev ) ;
Outputs the item referred to by VCP::Rev $rev. If this is the first call, then $self->none_seen will be TRUE and any preamble should be emitted.
MUST BE OVERRIDDEN. Don't call this from the override.
Copyright 2000, Perforce Software, Inc. All Rights Reserved.
This module and the VCP package are licensed according to the terms given in the file LICENSE accompanying this distribution, a copy of which is included in vcp.
Barrie Slaymaker <barries@slaysys.com>
1 POD Error
The following errors were encountered while parsing the POD:
You forgot a '=back' before '=head1'
To install VCP, copy and paste the appropriate command in to your terminal.
cpanm
cpanm VCP
CPAN shell
perl -MCPAN -e shell install VCP
For more information on module installation, please visit the detailed CPAN module installation guide.