xref: /aosp_15_r20/external/ltp/testcases/open_posix_testsuite/QUICK-START (revision 49cdfc7efb34551c7342be41a7384b9c40d7cab7)
1
2QUICK-START
3***********
4
5So 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?
6
7No worries! Here's a quick doc to help you around POSIX** Test Suite.
8
9========================
10Setting up your machine
11========================
12
13* See the "BUILD" file for info on how to set up the Makefile and your machine,
14  depending on what specific area you are concentrating on.
15(Signals, Semaphores, Threads, Timers or Message Queues).
16
17===================
18Running the tests
19===================
20
21* Easiest way to run all the tests is to do a "./configure && make all"
22  in the top-level directory.
23
24* To run tests for a specific directory, do the following
25  - make generate-makefiles # only required for the first shot.
26  - cd <subdir> ; make all test
27
28  Example:
29
30  - make generate-makefiles
31  - cd conformance/interfaces/pthread_create ; make all test
32
33* Running tests for a specific focus can be done like so:
34  run-posix-option-group-test.sh [OPTION-GROUP]
35
36* For additional information on how to build and run the tests in this
37  suite, see Documentation/HOWTO_RunTests.
38
39==========================
40Documentation & Resources
41==========================
42
43POSIX* Test Suite project page: http://posixtest.sf.net
44
45BUILD			- describes how to set up your developer machine to build and test
46
47The following files give developers information on how to write test
48cases for the project (under Documentation):
49
50HOWTO_Assertions    	- describes format of the assertions files used to
51                       	map test case descriptions to test cases
52HOWTO_BoundaryTest    	- information about testing boundary conditions
53HOWTO_CodingGuidelines	- describes coding guidelines for this project
54HOWTO_Coverage        	- describes format of COVERAGE.<area> files
55HOWTO_DefinitionsTest 	- ideas behind testing POSIX header files
56HOWTO_ResultCodes     	- standardized return codes for tests
57HOWTO_Tagging         	- describes how to tag files for inclusion in a release
58HOWTO_RunTests		- describes how to build and run the tests
59
60** POSIX (R) is a registered trademark of the IEEE
61
62Maintainer:	Ling Yu ([email protected])
63