blob: 6f5d881b4356cc45b9f85778534ec86735dad695 [file] [log] [blame]
robbiew0dc07652005-06-03 16:29:48 +00001
2QUICK-START
3***********
4
Chris Dearman37550cf2012-10-17 19:54:01 -07005So you're in a hurry and don't feel like reading all those docs in the Documentation section that we have worked so hard to write huh?
robbiew0dc07652005-06-03 16:29:48 +00006
7No worries! Here's a quick doc to help you around POSIX** Test Suite.
8
9========================
10Setting up your machine
11========================
12
13* There is nothing to install, the suite is intended to be run directly.
14
Garrett Cooper5e3aabb2010-07-10 16:42:59 -070015* See the "BUILD" file for info on how to set up the Makefile and your machine,
Chris Dearman37550cf2012-10-17 19:54:01 -070016 depending on what specific area you are concentrating on.
Garrett Cooper5e3aabb2010-07-10 16:42:59 -070017(Signals, Semaphores, Threads, Timers or Message Queues).
robbiew0dc07652005-06-03 16:29:48 +000018
robbiew0dc07652005-06-03 16:29:48 +000019===================
20Running the tests
21===================
22
Garrett Cooper5e3aabb2010-07-10 16:42:59 -070023* Easiest way to run all the tests is to do a "make all" in the top-level
24 directory.
robbiew0dc07652005-06-03 16:29:48 +000025
Garrett Cooper5e3aabb2010-07-10 16:42:59 -070026* To run tests for a specific directory, do the following
27 - make generate-makefiles # only required for the first shot.
28 - cd <subdir> ; make all test
robbiew0dc07652005-06-03 16:29:48 +000029
Garrett Cooper5e3aabb2010-07-10 16:42:59 -070030 Example:
robbiew0dc07652005-06-03 16:29:48 +000031
Garrett Cooper5e3aabb2010-07-10 16:42:59 -070032 - make generate-makefiles
33 - cd conformance/interfaces/pthread_create ; make all test
34
Garrett Cooperb24cfbd2010-07-19 02:14:30 -070035* Running tests for a specific focus can be done like so:
36 run-posix-option-group-test.sh [OPTION-GROUP]
robbiew0dc07652005-06-03 16:29:48 +000037
38* For additional information on how to build and run the tests in this
Garrett Cooperb24cfbd2010-07-19 02:14:30 -070039 suite, see Documentation/HOWTO_RunTests.
robbiew0dc07652005-06-03 16:29:48 +000040
41==========================
42Documentation & Resources
43==========================
44
45POSIX* Test Suite project page: http://posixtest.sf.net
46
subrata_modak02011d72007-07-26 12:02:10 +000047BUILD - describes how to set up your developer machine to build and test
robbiew0dc07652005-06-03 16:29:48 +000048
49The following files give developers information on how to write test
50cases for the project (under Documentation):
51
subrata_modak02011d72007-07-26 12:02:10 +000052HOWTO_Assertions - describes format of the assertions files used to
53 map test case descriptions to test cases
54HOWTO_BoundaryTest - information about testing boundary conditions
55HOWTO_CodingGuidelines - describes coding guidelines for this project
56HOWTO_Coverage - describes format of COVERAGE.<area> files
57HOWTO_DefinitionsTest - ideas behind testing POSIX header files
58HOWTO_ResultCodes - standardized return codes for tests
59HOWTO_Tagging - describes how to tag files for inclusion in a release
60HOWTO_RunTests - describes how to build and run the tests
robbiew0dc07652005-06-03 16:29:48 +000061
62** POSIX (R) is a registered trademark of the IEEE
63
subrata_modak02011d72007-07-26 12:02:10 +000064Maintainer: Ling Yu (ling.l.yu@intel.com)