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