blob: fbebfecbf61bba5401ba2af167748664e51dd916 [file] [log] [blame]
alaffin198500d2000-08-21 22:18:17 +00001Linux Test Project
subrata_modak7509b212008-08-27 13:36:52 +00002(Maintained by: Subrata Modak<subrata@linux.vnet.ibm.com>)
robbiew6f3a9f32002-06-07 18:21:19 +00003
4The latest image is always available at http://ltp.sf.net
alaffin198500d2000-08-21 22:18:17 +00005
alaffin198500d2000-08-21 22:18:17 +00006
nstraz0312c252000-09-26 20:59:21 +00007About the Linux Test Project
alaffin198500d2000-08-21 22:18:17 +00008
robbiew9ea3ce72001-09-18 20:38:09 +00009The Linux Test Project is a joint project with SGI, IBM, OSDL, and Bull with a
robbiew0eea3522004-02-05 17:33:10 +000010goal to deliver test suites to the open source community that validate the
11reliability, robustness, and stability of Linux. The Linux Test Project is a
12collection of tools for testing the Linux kernel and related features. Our goal
13is to improve the Linux kernel by bringing test automation to the kernel testing
robbiew9ea3ce72001-09-18 20:38:09 +000014effort. Interested open source contributors are encouraged to join the project.
alaffin198500d2000-08-21 22:18:17 +000015
nstraz0312c252000-09-26 20:59:21 +000016
17In the Package
alaffin198500d2000-08-21 22:18:17 +000018--------------
nstraz0312c252000-09-26 20:59:21 +000019Here is a short description of what is included in this package
alaffin198500d2000-08-21 22:18:17 +000020
nstraz0312c252000-09-26 20:59:21 +000021INSTALL
22 Installation documentation and quick start guide
alaffin198500d2000-08-21 22:18:17 +000023
nstraz0312c252000-09-26 20:59:21 +000024README
25 This document
alaffin198500d2000-08-21 22:18:17 +000026
nstraz0312c252000-09-26 20:59:21 +000027CREDITS
28 Credits to those who have contributed to the project.
alaffin198500d2000-08-21 22:18:17 +000029
nstraz0312c252000-09-26 20:59:21 +000030COPYING
robbiew0eea3522004-02-05 17:33:10 +000031 GNU General Public License
alaffin198500d2000-08-21 22:18:17 +000032
nstraz0312c252000-09-26 20:59:21 +000033ChangeLog
34 An incomplete list of changes to the project. We will try harder to
35 keep this up to date.
nstrazf307d5f2000-09-14 21:54:44 +000036
nstraz0312c252000-09-26 20:59:21 +000037Makefile
robbiew0eea3522004-02-05 17:33:10 +000038 Top level make file for LTP.
nstraz0312c252000-09-26 20:59:21 +000039
40runalltests.sh
41 A simple script to run all of the packaged tests in sequential order and
robbiew0eea3522004-02-05 17:33:10 +000042 report the overall result.
nstraz0312c252000-09-26 20:59:21 +000043
robbiew9ea3ce72001-09-18 20:38:09 +000044diskio.sh
nstrazd226d9d2002-01-09 23:03:50 +000045 A simple script to run all the diskio tests that pertain to the CD-ROM
46 and floppy disk file systems.
robbiew9ea3ce72001-09-18 20:38:09 +000047
48networktests.sh
nstrazd226d9d2002-01-09 23:03:50 +000049 A simple script to run all the network related tests that require
50 another remote machine.
robbiew9ea3ce72001-09-18 20:38:09 +000051
nstraz0312c252000-09-26 20:59:21 +000052doc/*
53 Documentation for the project including man pages for some of the
robbiewca0a7de2001-09-25 18:58:43 +000054 tools & library functions, as well as descriptions of every test.
nstraz0312c252000-09-26 20:59:21 +000055
nstraz0312c252000-09-26 20:59:21 +000056
57include/*
58lib/*
59 The include and lib directories contain headers and codes for common
60 routines used by many of the tests. We have tried to keep this to a
robbiew0eea3522004-02-05 17:33:10 +000061 minimum.
nstraz0312c252000-09-26 20:59:21 +000062
robbiew9ea3ce72001-09-18 20:38:09 +000063testcases/*
nstrazd226d9d2002-01-09 23:03:50 +000064 Contains all tests that run under the LTP as well as the "bin"
robbiew0eea3522004-02-05 17:33:10 +000065 directory, which has hardlinks to all the test executables.
nstraz0312c252000-09-26 20:59:21 +000066
67runtest/*
robbiew9ea3ce72001-09-18 20:38:09 +000068 It houses command lists that are used by pan for automated testing.
69
nstraz0312c252000-09-26 20:59:21 +000070pan/*
71 The pan directory contains a simple, lightweight test harness. pan
72 has the ability to run tests randomly and in parallel. See pan's man
73 page for more information.
alaffin198500d2000-08-21 22:18:17 +000074
nstrazd226d9d2002-01-09 23:03:50 +000075scratch/*
76 The scratch directory is a dumping ground for snippets and test cases
77 that we found but haven't integrated into LTP yet. Feel free to suggest
78 new snippets to be added, or take one of these and finish it off.
alaffin198500d2000-08-21 22:18:17 +000079
subrata_modak0c5f9702007-04-26 11:02:47 +000080testcases/kernel/containers/*
subrata_modak8cd73052007-06-22 10:28:26 +000081 Contains all the testcases related to container functionality ( e.g: sysvipc, utsname etc..)
subrata_modak0c5f9702007-04-26 11:02:47 +000082 For further information on the each of the container functionality refer
83 the following file: testcases/kernel/containers/README
84
85
nstraz0312c252000-09-26 20:59:21 +000086Warning!
87--------
alaffin198500d2000-08-21 22:18:17 +000088Be careful with these tests!
89
90Don't run them on production systems. Growfiles, doio, and iogen in particular
91stress the I/O capabilities of systems and while they should not cause problems
92on properly functioning systems, they are intended to find (or cause) problems.
nstraz0312c252000-09-26 20:59:21 +000093
94
95Contact Information and Updates
96-------------------------------
97
robbiew9ea3ce72001-09-18 20:38:09 +000098URL: http://ltp.sf.net
nstraz0312c252000-09-26 20:59:21 +000099
nstrazd226d9d2002-01-09 23:03:50 +0000100Questions and comments should be sent to the LTP mailing list located on the
robbiew0eea3522004-02-05 17:33:10 +0000101project page.
nstraz0312c252000-09-26 20:59:21 +0000102
subrata_modak23f869f2007-04-09 12:03:49 +0000103Using KDUMP test automation suite
104---------------------------------
subrata_modak23f869f2007-04-09 12:03:49 +0000105For more information on how to use the kdump test automation suite please refer
106to file testcases/kdump/README.
107
subrata_modak9b555d12007-08-24 09:41:59 +0000108Using NUMA test automation suite
109---------------------------------
110For more information on how to use the 'numa' test automation suite please refer
111to file testcases/kernel/numa/README.
112