NAME

Parrot::Configure::Options - Process command-line options to Configure.pl

SYNOPSIS

    use Parrot::Configure::Options qw( process_options );

    $args = process_options( {
        mode    => q{configure},
    } );

DESCRIPTION

Parrot::Configure::Options exports on demand the subroutine process_options(), which processes the command-line options provided to Configure.pl.

If you provide Configure.pl with either --help or --version, process_options() will print out the appropriate message and perform a bare return, i.e., the return value will be undef. The calling script -- whether Configure.pl or a test file -- can then check for the definedness of process_options()'s return value and proceed appropriately.

An array of valid command-line option names stored internally is consulted; the program will die if an invalid option is called.

SUBROUTINES

process_options()

• Purpose

  Process command-line options provided to Configure.pl and proceed appropriately.

• Arguments

  One argument: Reference to a hash holding the following key-value pairs:

      argv            : reference to @ARGV; defaults to []
      script          : Perl's $0:  the calling program;
                        defaults to 'Configure.pl'
      parrot_version  : string holding Parrot version number
                        (currently supplied by
                        Parrot::BuildUtil::parrot_version())
      svnid           : string holding Subversion Id string

• Return Value

  • --version or --help

    Bare return (undef).

  • All other options

    Reference to a hash of option names and values.

• Comment

NOTES

The functionality in this package was transferred from Configure.pl by Jim Keenan.

SEE ALSO

Configure.pl.