NAME

Parrot::Ops2pm::Auxiliary - Non-method subroutines holding functionality for tools/build/ops2pm.pl.

SYNOPSIS

use Parrot::Ops2pm::Auxiliary qw( Usage getoptions );

Usage();

$flagref = getoptions();

DESCRIPTION

Parrot::Ops2pm::Auxiliary provides subroutines called by tools/build/ops2pm.pl, a program which is called at the very beginning of the Parrot make process. This package is intended to hold subroutines used by that program other than the object-oriented methods provided by Parrot::Ops2pm.

Extraction of the subroutines exported by this package from tools/build/ops2pm.pl facilitates the testing of their functionality by the tests in t/tools/ops2pmutils/*.t.

SUBROUTINES

Usage()

  • Purpose

    Display a short description of how to use tools/build/ops2pm.pl on standard output.

    usage: tools/build/ops2pm.pl [--help] [--no-lines] input.ops [input2.ops ...]
  • Arguments

    None.

  • Return Value

    Implicitly returns true upon successful printing.

getoptions

  • Purpose

    Process arguments provided on command-line to tools/build/ops2pm.pl.

  • Arguments

    None.

  • Return Value

    Hash reference where any of the following keys may or may not be defined.

    no-lines
    help
    renum
  • Comment

    A wrapper around Getopt::Long::GetOptions() designed to assure testability.

AUTHOR

Jim Keenan (refactoring code originally found in tools/build/ops2pm.pl).

SEE ALSO

Parrot::Ops2pm. tools/build/ops2pm.pl.