LCFG::Build::Tool - LCFG software packaging tool
This documentation refers to LCFG::Build::Tool version 0.0.58
This is an interface and cannot be instantiated directly.
This module provides software release tools for the LCFG build suite.
This class is an interface which must be implemented by any LCFG build tool. It has a set of attributes which are relevant to all implementing classes. Any class implementing this interface must provide a run() method.
More information on the LCFG build tools is available from the website http://www.lcfg.org/doc/buildtools/
The following attributes are modifiable via the command-line (i.e. via @ARGV) as well as the normal way when the Tool object is created. Unless stated the options take strings as arguments and can be used like
--foo=bar. Boolean options can be expressed as either
--no-foo to signify true and false values.
A boolean value which indicates whether actions which permanently alter the contents of files should be carried out. The default value is false (0). When running in dry-run mode various you will typically get extra output to the screen showing what would have been done.
A boolean value which indicates whether the actions should attempt to be quieter. The default value is false (0).
The path of the project directory which contains the software for which you want to create a release. If this is not specified then a default value of the current directory (.) will be used. This directory must already contain the LCFG build metadata file (lcfg.yml) for the software.
When a project is packaged for release the generated products (the gzipped source tar file, various build metadata files and possibly binary RPMS, etc) are stored into a directory named after the combination of the full name of the project and the version number. For example, a project named 'foo' with version '1.2.3' would have an output directory of 'foo-1.2.3'. You should note that if the
base attribute is specified in the metadata file (this is the case for LCFG components) then that is also used. If the previous example was an LCFG component it would have a directory named 'lcfg-foo-1.2.3'.
This attribute controls the parent directory into which that generated directory will be placed. The default on a Unix system is
$HOME/lcfgbuild/ which will be created if it does not already exist.
The following methods are not modifiable by the command-line, they are however directly modifiable via the Tool object if necessary. Typically you will only need to query these attributes, they are automatically created when you need them using values for some of the other command-line attributes.
This is a reference to the current project metadata object, see LCFG::Build::PkgSpec for full details.
This is a reference to the current version-control object, see LCFG::Build::VCS and associated helper modules for full details.
Any class implementing this interface MUST have a run() method.
Immediately fails (i.e. dies) and displays the message.
Logs the message to the screen if the
quiet attribute has not been specified. A message string is prefixed with 'LCFG: ' to help visually separate it from other output.
This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.
FedoraCore5, FedoraCore6, ScientificLinux5
There are no known bugs in this application. Please report any problems to email@example.com, feedback and patches are also always very welcome.
Stephen Quinney <firstname.lastname@example.org>
Copyright (C) 2008 University of Edinburgh. All rights reserved.
This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.