[LTP] [RFC PATCH 1/7] doc: Remove ltp-run-files.txt

Petr Vorel pvorel@suse.cz
Mon Oct 16 20:44:02 CEST 2023


This file contained runtest file description + list of various scripts
in testcases directory. Scripts list are outdated (some has been
already deleted, others will be deleted).

The format of the LTP runtest file is described in
doc/C-Test-Case-Tutorial.asciidoc and
doc/Test-Writing-Guidelines.asciidoc, improve the description.

Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
 doc/Test-Writing-Guidelines.asciidoc | 12 ++++
 doc/ltp-run-files.txt                | 96 ----------------------------
 2 files changed, 12 insertions(+), 96 deletions(-)
 delete mode 100644 doc/ltp-run-files.txt

diff --git a/doc/Test-Writing-Guidelines.asciidoc b/doc/Test-Writing-Guidelines.asciidoc
index 0db852ae6..a81404fa6 100644
--- a/doc/Test-Writing-Guidelines.asciidoc
+++ b/doc/Test-Writing-Guidelines.asciidoc
@@ -262,6 +262,18 @@ The list of tests to be executed is stored in runtest files under the
 stored in 'scenario_groups/default'. When you add a test you should add
 corresponding entries into some runtest file(s) as well.
 
+Each line of runtest file contain one test. First item is the test name
+('shell_test01', 'splice02'). All other items, separated by space will be
+executed ('echo "SUCCESS" | shell_pipe01.sh', 'splice02 -s 20').
+
+[source,sh]
+-------------------------------------------------------------------------------
+shell_test01 echo "SUCCESS" | shell_pipe01.sh
+splice02 splice02 -s 20
+-------------------------------------------------------------------------------
+
+Blank lines and lines starting with a '#' (comments) are ignored.
+
 For syscall tests (these placed under 'testcases/kernel/syscalls/') use
 'runtest/syscalls' file, for kernel related tests for memory management we
 have 'runtest/mm', etc.
diff --git a/doc/ltp-run-files.txt b/doc/ltp-run-files.txt
deleted file mode 100644
index 3f405b387..000000000
--- a/doc/ltp-run-files.txt
+++ /dev/null
@@ -1,96 +0,0 @@
-The runtest files contain a list of test cases to be executed.
-
-File Format
------------
-
-Lines starting with a '#' are comments and blank lines are ignored.
-
-Otherwise, lines start with a test name followed by white space, then some
-shell script to be executed. For example
-
-Test Name
-|       Delimiter               Test case argument
-|       |                       |
-v       v                       v
-splice02 seq 1 20000 | splice02 splice02-temp
-         ^             ^                    ^
-         |             |                    |
-         |             Test case executable |
-         -----------Shell script-------------
-
-So the splice02 runtest entry pipes the output of seq into the splice02 test
-executable. Most runtest entries are simpler than this, for example
-
-splice03 splice03
-
-Here the test name and executable have the same name and no arguments have
-been supplied.
-
-Run test files should start with a comment describing the tests they contain,
-e.g.
-
-#DESCRIPTION:Kernel system calls
-
-Note that the LTP has absorbed a number of other projects. Some of these have
-been fully converted to the LTP format, others have runtest files generated
-for them during installation, while some use a shell script to integrate them
-with the other tests.
-
-Test suites
------------
-
- - syscalls  (except epoll, see below)
- - fs
- - fsx
- - dio
- - mm
- - ipc
- - sched
- - math
- - pty
-
-if run network tests flag is passed these additional tests are run
- - tcp_cmds
- - multicast
- - rpc
- - nfs
-
-To test filesystem with LVM
-- testscripts/lvmtest.sh
-
-Device Mapper tests
- - ltpdmmapper.sh
-
-Network tests
- - network.sh
- - testcases/network/sockets/ltpSockets.sh
-
-other filesystem or disk type tests
- - autofs1.sh
- - autofs4.sh
- - diskio.sh
- - isofs.sh
- - sysfs.sh
-
-AIO/DIO filesystem tests
- - ltp-aiodio.sh
-
-Device driver tests (may not run on all platforms)
- - acpi
- - agp
- - base
- - drm
- - include
- - nls
- - pci
- - tbio
- - usb
-
-Open_hpi_testsuite
- - run_tests
-
-Open_posix_testsuite
- - run_tests
-
-
-testcases/kernel/syscalls/epoll - The tests require additional installation files. See the README in the epoll directory.
-- 
2.42.0



More information about the ltp mailing list