Lit - a portable Perl reimplementation of LLVM's lit and FileCheck
=================================================================

Two test-suite tools modelled on LLVM's lit (the LLVM Integrated Tester)
and FileCheck, written in pure Perl with no non-core dependencies, for
hosts where the Python originals cannot run.  Everything works on OpenVMS
- VAX, Alpha, I64 and x86-64 - as well as Tru64 and Linux.


Installing
----------

    unzip Lit-1.00.zip
    perl Makefile.PL
    make
    make test
    make install

On OpenVMS:

    $ UNZIP "-a" LIT-1_00.ZIP
    $ PERL MAKEFILE.PL
    $ MMK                          ! or MMS, or MAKE
    $ MMK TEST
    $ MMK INSTALL


Documentation
-------------

All of it is POD, so it installs as manual pages alongside the code:

    perldoc Lit                overview, installation, getting started
    perldoc lit.pl             the test driver and its options
    perldoc filecheck.pl       the output matcher and its options

    perldoc Lit::Config        writing a lit.cfg; the $config API
    perldoc Lit::LitConfig     --param values and host features
    perldoc Lit::TestRunner    RUN:/REQUIRES:/XFAIL: and substitutions
    perldoc Lit::BoolExpr      the feature expression language
    perldoc Lit::ShLex         shell syntax accepted in RUN: lines
    perldoc Lit::ShRun         how a RUN: line is executed
    perldoc Lit::Builtins      the builtin commands
    perldoc Lit::FileCheck     FileCheck directives and options
    perldoc Lit::Pattern       FileCheck pattern syntax
    perldoc Lit::Porting       porting a Python lit.cfg by hand
    perldoc Lit::Compat        host portability internals

Before installing, read it from the source tree with e.g.

    perldoc lib/Lit.pm

Worked examples are in examples/: a small complete suite in examples/demo
(run it with "perl bin/lit.pl -v examples/demo"), and an annotated OpenVMS
compiler-suite config in examples/openvms-lit.cfg.


Licence
-------

Copyright (c) 2026 Endless Software Solutions

Licensed on the same terms as Perl itself: the GNU General Public
License version 1 (or, at your option, any later version), or the
Artistic License.  See LICENSE.md for the full text of both.