NAME

SYNOPSIS

DESCRIPTION

OPTIONS

--bootstrap

  --bootstrap=pattern
    

Forces all files matching the given shell regular expression (may use wildcards like "*", "?", and "...") to have their first revisions transferred as complete copies instead of deltas. This is useful when you want to transfer a revision other than the first revision as the first revision in the target repository. It is also useful when you want to skip some revisions in the target repository (although the Map filter has superceded this use).

--continue

Tells VCP to continue where it left off from last time. This will not detect new branches of already transferred revisions (this limitation should be lifted, but results in an expensive rescan of metadata), but will detect updates to already transferred revisions.

--rev-root

Tells VCP to extract files relative to a directory in the source repository other than the default directory. Ordinarily, VCP looks at the source specification and deduces that the lowest complete directory name is the "root" directory for all revisions, or the "rev_root".

For instance, given the specification:

    cvs:foo/bar/...
    

the rev_root will be "foo/bar" and the files under bar will be extracted with a path relative to bar, so "foo/bar/baz/bat" will be extracted with the value "baz/bat".

They will be inserted in the destination repository relative to the rev_root for the destination, so if the destination spec is like:

    p4://depot/...
    

then "baz/bat" will be inserted in the destination as "//depot/baz/bat".

If there is no target rev_root specified, as in the spec:

    p4:
    

then the source's rev_root will be assumed, so "baz/bat" in our example would be placed in "//foo/bar/baz/bat".

SUBCLASSING

SUBCLASS OVERLOADS

scan_metadata

This is called to scan the metadata for the source repository. It should call rev_mode() for each revision found (including any that need to be concocted to make up for collapsed metadata in the source, like VSS or CVS deletes or CVS branch creation) and if that returns TRUE, then queue_rev() should be called.

If rev_mode() returns "base", then the transfer is in --continue mode and this rev should be built as or converted to a base revision. The easiest way to do this is to build it normally and then call $r->base_revify().

If the metadata source returns metadata from most recent to oldest, as do most file history reports, the previous_id() need not be set until the next revision in a filebranch is scanned. The most recent rev passed to queue_rev() is available by calling last_rev(), if the metadata is one branch at a time, and the last rev in each filebranch is available by calling last_rev_for_filebranch().

If the metadata is scanned one file or filebranch at a time and branched are all created by the time the end of a file's metadata arrives, calling store_cached_revs() will flush all queued revs from the last_rev() and last_rev_for_filebranch() in-memory caches to the disk cache (all other revs are flushed as their successors arrive).

There is no easy way to handle randomly ordered metadata at this time, typically a source will accumulate as little as it can in memory and queue the rest. See VCP::Source::cvs for an example of this.

Once scan_metadata() is complete, send_revs() will be called automatically.

get_source_file

REQUIRED OVERLOAD.

All sources must provide a way for the destination to fetch a revision.

handle_header

REQUIRED OVERLOAD.

Subclasses must add all repository-specific info to the $header, at least including rep_type and rep_desc.

   $header->{rep_type} => 'p4',
   $self->p4( ['info'], \$header->{rep_desc} ) ;
    

The subclass must pass the $header on to the dest:

   $self->dest->handle_header( $header )
      if $self->dest;
    

This may be called when dest is null to allow the source to initialize itself when it won't be scanning the real source. So the if $self->dest is important.

That's not the case for copy_revs().

handle_footer

Not a required overload, as the footer carries no useful information at this time. Overriding methods must call this method to pass the $footer on:

   $self->SUPER::handle_footer( $footer ) ;
    

parse_time

   $time = $self->parse_time( $timestr ) ;
    

Parses "[cc]YY/MM/DD[ HH[:MM[:SS]]]".

Will add ability to use format strings in future. HH, MM, and SS are assumed to be 0 if not present.

Returns a time suitable for feeding to localtime or gmtime.

Assumes local system time, so no good for parsing times in revml, but that's not a common thing to need to do, so it's in VCP::Source::revml.pm.

bootstrap

Sets (and parses) or gets the bootstrap spec.

Can be called plain:

   $self->bootstrap( $bootstrap_spec ) ;
    

See the command line documentation for the format of $bootstrap_spec.

is_bootstrap_mode

   ... if $self->is_bootstrap_mode( $file ) ;
    

Compares the filename passed in against the list of bootstrap regular expressions set by "bootstrap".

The file should be in a format similar to the command line spec for whatever repository is passed in, and not relative to rev_root, so "//depot/foo/bar" for p4, or "module/foo/bar" for cvs.

This is typically called in the subbase class only after looking at the revision number to see if it is a first revision (in which case the subclass should automatically put it in bootstrap mode).

COPYRIGHT

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.

AUTHOR