John D. Fa'atuai > REST-Resource-0.5.2.4 > Build.PL

Download:
REST-Resource-0.5.2.4.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

    Build.PL    -- Module::Build Build script for REST::Resource

SYNOPSIS ^

    perl Build.PL
    ./Build             ## or perl Build
    ./Build test
    ./Build install

DESCRIPTION ^

    This script is the build script for REST::Resource.  This build
    script is intended to be run under two semantic environments:

    [1] The master CruiseControl server that allocates builds by
    the module author.

    [2] CPAN users, who will use the last built build-label.

FILES ^

    ./Build.PL                  - This script.
    ./etc/build_number.txt      - The module-persistent build number.

AUTHOR ^

    frotz@acm.org       John "Frotz" Fa'atuai   ffaatuai@cisco.com

METHODS ^

main()

USAGE:

    &main( $build_label, $build_time );
    exit( 0 );

DESCRIPTION:

    This method allocates a Module::Build instance, which verifies the
    environment requirements and generates the resulting ./Build
    script.  Additionally, if run on Windows, a batch file wrapper is
    generated.

    The parameters below are ONLY used by the master CruiseControl
    instance.  They are not used by CPAN module users.

PARAMETERS:

    $build_label        -- CruiseControl build-label value.
    $build_time         -- CruiseControl build-time value.

read()

USAGE:

    my( $contents )     = &read( $file );

DESCRIPTION:

    This method will read the specified file and return its contents
    to the caller as a scalar.

write()

USAGE:

    &write( $file, $contents );

DESCRIPTION:

    This method will [re-]write the specified file with $contents.

update()

USAGE:

    &update( $filename, $signature, $build_number );

DESCRIPTION:

    This method will update $filename by replacing any line matching
    the $signature pattern with:

        our( $VERSION ) = '$build_number';

repository_commit()

USAGE:

    &repository_commit();

DESCRIPTION:

    This code should ONLY be invoked on a machine that has access to
    the Subversion (either the master or a mirror).  This method
    handles the final check-in and commit of changes within the build
    tree.

    In a perfect world, there is nothing to commit.
syntax highlighting: