Fink::SelfUpdate::Base(3) Fink documentation Fink::SelfUpdate::Base(3)NAMEFink::SelfUpdate::Base - base class for selfupdate-method classes
DESCRIPTION
Each method of selfupdating will soon be encapsulated in a
Fink::SelfUpdate::$method class, which are subclasses of the
Fink::SelfUpdate::Base class. There are stub methods for the public
interface calls, so a $method class only needs to override as needed.
All calls are class methods at this time.
description
my $label = Fink::SelfUpdate::$method->description();
Returns a short description of this method, similar to the
Description field of a package. Defaults to the package-name (no
leading classes) as lower-case.
system_check
my $boolean = Fink::SelfUpdate::$method->system_check();
Determine whether this method can be used on this machine. Make
sure needed external executables are present, etc. Must be over-
ridden.
devtools_check
my $boolean = Fink::SelfUpdate::$method->devtools_check($vcs, $vcs_exec);
Common test for all selfupdate methods.
If the "dev-tools" virtual package doesn't exist, or if the
executable referenced by $vcs_executable isn't executable
(typically this means not installed), devtools_check() returns 0
and prints an OS-versioned warning about what Xcodes to install and
where to get them.
clear_metadata
Fink::SelfUpdate::$method->clear_metadata();
Remove all metadata files and other structures related to this
selfupdate class (example: CVS/ directories).
do_direct
my $data = Fink::SelfUpdate::$method->do_direct();
This implements the actual selfupdate sync process. Must be over-
ridden (obviously). Returns boolean indicating success. Must call
Fink::SelfUpdate::$method->do_direct before returning.
update_version_file
Fink::SelfUpdate::$method->update_version_file(%options);
Records information in %p/fink/$distribution/VERSION.selfupdate
about the just-done selfupdate. Returns nothing useful. Probably
safest to avoid overriding this class method. The following
%options are known:
distribution (optional)
Updates the VERSION file for the given value. Defaults to the
currently active distribution.
data (optional)
A single line of text containing method-specific information
(point-update version number, remote server info, etc).
Fink 0.36.3.1 2013-12-30 Fink::SelfUpdate::Base(3)