robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 1 | |
| 2 | QUICK-START |
| 3 | *********** |
| 4 | |
Chris Dearman | 37550cf | 2012-10-17 19:54:01 -0700 | [diff] [blame] | 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? |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 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 | |
Garrett Cooper | 5e3aabb | 2010-07-10 16:42:59 -0700 | [diff] [blame] | 15 | * See the "BUILD" file for info on how to set up the Makefile and your machine, |
Chris Dearman | 37550cf | 2012-10-17 19:54:01 -0700 | [diff] [blame] | 16 | depending on what specific area you are concentrating on. |
Garrett Cooper | 5e3aabb | 2010-07-10 16:42:59 -0700 | [diff] [blame] | 17 | (Signals, Semaphores, Threads, Timers or Message Queues). |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 18 | |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 19 | =================== |
| 20 | Running the tests |
| 21 | =================== |
| 22 | |
Garrett Cooper | 5e3aabb | 2010-07-10 16:42:59 -0700 | [diff] [blame] | 23 | * Easiest way to run all the tests is to do a "make all" in the top-level |
| 24 | directory. |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 25 | |
Garrett Cooper | 5e3aabb | 2010-07-10 16:42:59 -0700 | [diff] [blame] | 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 |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 29 | |
Garrett Cooper | 5e3aabb | 2010-07-10 16:42:59 -0700 | [diff] [blame] | 30 | Example: |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 31 | |
Garrett Cooper | 5e3aabb | 2010-07-10 16:42:59 -0700 | [diff] [blame] | 32 | - make generate-makefiles |
| 33 | - cd conformance/interfaces/pthread_create ; make all test |
| 34 | |
Garrett Cooper | b24cfbd | 2010-07-19 02:14:30 -0700 | [diff] [blame] | 35 | * Running tests for a specific focus can be done like so: |
| 36 | run-posix-option-group-test.sh [OPTION-GROUP] |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 37 | |
| 38 | * For additional information on how to build and run the tests in this |
Garrett Cooper | b24cfbd | 2010-07-19 02:14:30 -0700 | [diff] [blame] | 39 | suite, see Documentation/HOWTO_RunTests. |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 40 | |
| 41 | ========================== |
| 42 | Documentation & Resources |
| 43 | ========================== |
| 44 | |
| 45 | POSIX* Test Suite project page: http://posixtest.sf.net |
| 46 | |
subrata_modak | 02011d7 | 2007-07-26 12:02:10 +0000 | [diff] [blame] | 47 | BUILD - describes how to set up your developer machine to build and test |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 48 | |
| 49 | The following files give developers information on how to write test |
| 50 | cases for the project (under Documentation): |
| 51 | |
subrata_modak | 02011d7 | 2007-07-26 12:02:10 +0000 | [diff] [blame] | 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 |
robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 61 | |
| 62 | ** POSIX (R) is a registered trademark of the IEEE |
| 63 | |
subrata_modak | 02011d7 | 2007-07-26 12:02:10 +0000 | [diff] [blame] | 64 | Maintainer: Ling Yu (ling.l.yu@intel.com) |