PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Package Foswiki::Contrib::Build

This is a base class used for making build scripts for Foswiki packages.

Methods

new($project)

Construct a new build object. Define the basic directory paths to places in the build/release. Read the manifest topic and build file and dependency lists. Parse command line to get target and options.

pushd($dir)

Change to the given directory

popd()

Pop a dir level, previously pushed by pushd

rm($file)

Remove the given file (or directory)

makepath($to)

Make a directory and all directories leading to it.

cp($from, $to)

Copy a single file from - to. Will automatically make intervening directories in the target. Also works for target directories.

prot($perms, $file)

Set permissions on a file. Permissions should be expressed using POSIX chmod notation.

sys_action(@params)

Perform a "system" command.

perl_action($cmd)

Perform a "perl" command.

filter_txt

Expands tokens.

The filter is used in the generation of documentation topics and the installer

filter_pm($from, $to)

Filters expanding SVN rev number with correct version from repository Note: unlike subversion, this puts in the version number of the whole repository, not just this file.

copy_fileset

Copy all files in a file set from on directory root to another.

apply_perms

Apply perms to a fileset

target_build

Basic build target. All other build targets are implemented in the 'Targets' subdirectory in individual modules.

target_pod

Print POD documentation. This target does not modify any files, it simply prints the (TML format) POD.

POD text in .pm files should use TML syntax or HTML. Packages should be introduced with a level 1 header, ---+, and each method in the package by a level 2 header, ---++. Make sure you document any global variables used by the module.

build($target)

Build the given target

pre and post hooks will be executed before and after the target, repsectively. I.e., if $target is 'install' then method pre_target_install() will be executed before target_install(); and post_target_install() will be given control after the target. If target fails then post-hook will receive error object $@ as it's single parameter.