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