Ingy döt Net > YAML-Tests-0.06 > yt

Download:
YAML-Tests-0.06.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

yt - YAML Tester for Perl Implementations

SYNOPSIS ^

    # Run tests with yt
    > yt
    > yt -MYAML::Syck
    > yt -MYAML::Tiny -v dump.t load.t

    # List the yt tests
    > yt --list

    # Run benchmarks against the various YAML modules
    > yt --benchmark
    > yt --benchmark -r5000   # Run 5000 times
    > yt --benchmark YAML::Syck YAML::LibYAML   # Compare two modules

    # Show the version of yt, YAML::Tests and the YAML modules on your system
    > yt --version

DESCRIPTION ^

This command line tool, yt, can be used to run the entire YAML-Tests suite against a particular Perl YAML implementation.

yt is basically a wrapper around prove. As such, it accepts and passes along prove command line options. The main difference is that it knows where the YAML-Tests live and how to set up the environment to run them.

ENVIRONMENT VARIABLES ^

yt relies on two environment variables:

PERL_YAML_TESTS_BASE

This variable should be set to the absolute pathname of the directory containing the contents of the YAML-Tests module distribution.

You can get YAML-Tests from CPAN or its SVN repository:

    http://svn.kwiki.org/ingy/YAML-Tests/
PERL_YAML_TESTS_MODULE

This variable conatins the name of the Perl YAML module you want to test. It can be set as an environment variable, but is normally passed to yt by the -M flag:

    yt -MYAML::Syck    

AUTHOR ^

Ingy döt Net <ingy@cpan.org>

COPYRIGHT ^

Copyright (c) 2007. Ingy döt Net. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: