Blame tests/aslts/README

Packit Service 0129ce
Packit Service 0129ce
CONTENTS
Packit Service 0129ce
Packit Service 0129ce
   ACPICA ASL grammar validation Test Suite (ASLTS)
Packit Service 0129ce
Packit Service 0129ce
Packit Service 0129ce
   ASLTS verifies, in "hardware-independent" mode, conformity of ACPICA
Packit Service 0129ce
ASL compiler and interpreter to the ACPI ASL grammar specification. The
Packit Service 0129ce
more common task of ASLTS is to check, in "hardware-independent" mode also,
Packit Service 0129ce
all the functionality of ACPICA which can be initiated and then verified
Packit Service 0129ce
from inside the test modules coded in ASL. The first local task is performed
Packit Service 0129ce
by the test collection named 'functional', to achieve the second one the tests
Packit Service 0129ce
of other collections are intended: complex, exceptions, etc. The conditional
Packit Service 0129ce
difference between the tests of 'functional' and 'complex' collections is that
Packit Service 0129ce
the tests of 'functional' collection checks specific functionality of the
Packit Service 0129ce
particular ASL operator while the tests of 'complex' collection verify the
Packit Service 0129ce
more common functionality.
Packit Service 0129ce
Packit Service 0129ce
   The testing is performed in "hardware-independent" mode without any
Packit Service 0129ce
access to ACPI subsystem hardware. In this purpose the AcpiExec utility
Packit Service 0129ce
is used which includes the entire ACPICA subsystem and allows to execute
Packit Service 0129ce
the AML code and thus verify functionality of ACPICA subsystem.
Packit Service 0129ce
Packit Service 0129ce
   The ASL source code is compiled to AML code and then passed to
Packit Service 0129ce
AcpiExec utility. In this relation one more type tests are provided,
Packit Service 0129ce
so called ASL-compilation control test collection, which check ability
Packit Service 0129ce
of ASL compiler to reveal and report incorrect ASL code.
Packit Service 0129ce
Packit Service 0129ce
   The tests of the exceptional conditions test collection
Packit Service 0129ce
initiate and verify exceptional conditions, check that the
Packit Service 0129ce
exceptions occur (or not occur) in the expected specified way.
Packit Service 0129ce
Packit Service 0129ce
   The testing is provided in both 32-bit and 64-bit modes
Packit Service 0129ce
(option -r of ASL compiler) as well both normal and slack
Packit Service 0129ce
modes (option -s of AcpiExec).
Packit Service 0129ce
Packit Service 0129ce
Packit Service 0129ce
tmp
Packit Service 0129ce
Packit Service 0129ce
   directory is automatically created (if doesn't exist) while installing
Packit Service 0129ce
   or running the tests performed by the utility Do
Packit Service 0129ce
Packit Service 0129ce
tmp/aml
Packit Service 0129ce
Packit Service 0129ce
   directory is automatically created (if doesn't exist) while installing
Packit Service 0129ce
   the tests performed by the utility Do and contains 32-bit and 64-bit
Packit Service 0129ce
   AML codes of the tests
Packit Service 0129ce
Packit Service 0129ce
tmp/RESULTS
Packit Service 0129ce
Packit Service 0129ce
   directory is automatically created during the test execution
Packit Service 0129ce
   (if doesn't exist) initiated by the Do utility and contains results
Packit Service 0129ce
   (so called multi-results) of runs of tests - utility Do performs each
Packit Service 0129ce
   run of tests is several modes:
Packit Service 0129ce
       32-bit norm mode
Packit Service 0129ce
       64-bit norm mode
Packit Service 0129ce
       32-bit slack mode
Packit Service 0129ce
       32-bit slack mode
Packit Service 0129ce
   so the result of run of tests is called multi-result. It is located
Packit Service 0129ce
   into RESULTS/<date.time.revision> directory.
Packit Service 0129ce
Packit Service 0129ce
bin
Packit Service 0129ce
Packit Service 0129ce
   utilities to manager the tests
Packit Service 0129ce
Packit Service 0129ce
src
Packit Service 0129ce
Packit Service 0129ce
   source code of tests
Packit Service 0129ce
Packit Service 0129ce
TESTS
Packit Service 0129ce
Packit Service 0129ce
   per-collection list of run-time tests
Packit Service 0129ce
Packit Service 0129ce
HOW_TO_INSTALL
Packit Service 0129ce
Packit Service 0129ce
   actions needed to prepare the tests for running
Packit Service 0129ce
Packit Service 0129ce
HOW_TO_USE
Packit Service 0129ce
Packit Service 0129ce
   how to run the tests and explain the result of run
Packit Service 0129ce
Packit Service 0129ce
Makefile.def
Packit Service 0129ce
Packit Service 0129ce
   the common use targets and rules
Packit Service 0129ce
Packit Service 0129ce
Makefile.switch
Packit Service 0129ce
Packit Service 0129ce
   the uniform targets and rules to pass commands of make utility
Packit Service 0129ce
   to the specified enclosed directories
Packit Service 0129ce
Packit Service 0129ce
Makefile
Packit Service 0129ce
Packit Service 0129ce
   currect directory targets and rules
Packit Service 0129ce
Packit Service 0129ce
Packit Service 0129ce
         THE UNIFORM STRUCTURE OF ASLTS SOURCE CODE
Packit Service 0129ce
Packit Service 0129ce
The ASLTS source code contains files of the same name
Packit Service 0129ce
which are of the same functionality described below.
Packit Service 0129ce
Packit Service 0129ce
DECL.asl
Packit Service 0129ce
Packit Service 0129ce
   contains all the declarations corresponding to some test
Packit Service 0129ce
Packit Service 0129ce
RUN.asl
Packit Service 0129ce
Packit Service 0129ce
   contains all the invocations corresponding to some test
Packit Service 0129ce
Packit Service 0129ce
MAIN.asl
Packit Service 0129ce
Packit Service 0129ce
   contains declaration of DefinitionBlock corresponding to some test;
Packit Service 0129ce
   the DefinitionBlock contains method MAIN which is a starting method
Packit Service 0129ce
   of the test; as a rule, this file contains the relevant DECL.asl and
Packit Service 0129ce
   RUN.asl includes
Packit Service 0129ce
Packit Service 0129ce
README
Packit Service 0129ce
Packit Service 0129ce
   the brief description of the contents of the inclusive directory
Packit Service 0129ce
   (hierarchy of README files explaining the contents of directories)
Packit Service 0129ce
Packit Service 0129ce
FULL
Packit Service 0129ce
Packit Service 0129ce
   contains declaration of DefinitionBlock corresponding to some test
Packit Service 0129ce
   which is conglomeration of several other tests
Packit Service 0129ce
Packit Service 0129ce
NOTE
Packit Service 0129ce
Packit Service 0129ce
   any notes to not forget something to do etc.
Packit Service 0129ce
Packit Service 0129ce
- end