| robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 1 | |
| 2 | QUICK-START |
| 3 | *********** |
| 4 | |
| vapier | 22858b2 | 2006-05-21 23:47:08 +0000 | [diff] [blame^] | 5 | So you're in a hurry and don't feel like reading all those docs in the |
| 6 | Documentation section that we have worked so hard to write huh? |
| robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 7 | |
| 8 | No worries! Here's a quick doc to help you around POSIX** Test Suite. |
| 9 | |
| 10 | ======================== |
| 11 | Setting up your machine |
| 12 | ======================== |
| 13 | |
| 14 | * There is nothing to install, the suite is intended to be run directly. |
| 15 | |
| vapier | 22858b2 | 2006-05-21 23:47:08 +0000 | [diff] [blame^] | 16 | * See the "BUILD" file for info on how to set up the Makefile and your |
| 17 | developer machine, depending on what specific area you are concentrating on. |
| 18 | (Signals, Semaphores, Threads, Timers or Message Qs). |
| robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 19 | |
| vapier | 22858b2 | 2006-05-21 23:47:08 +0000 | [diff] [blame^] | 20 | * "LDFLAGS" is a file used by the Makefile to link to what you specify in it. |
| 21 | e.g. if you want to link with lpthread, you would open LDFLAGS and insert the |
| 22 | line "-lpthread". LDFLAGS has a few simple examples contained in it. |
| robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 23 | |
| 24 | =================== |
| 25 | Running the tests |
| 26 | =================== |
| 27 | |
| 28 | * Easiest way to run all the tests is to do a "make" in the top-level directory. |
| 29 | |
| 30 | * To run tests for a specific directory, first export the POSIX_TARGET variable |
| 31 | to the directory you want, then perform a "make". e.g.: |
| 32 | # export POSIX_TARGET=conformance/interfaces/pthread_create |
| 33 | # make |
| 34 | |
| 35 | * An easy way to run all tests specific to your area of focus, run: |
| 36 | |
| 37 | # ./run_tests [MEM|MSG|SEM|SIG|THR|TMR|TPS] |
| 38 | the argument is the 3 letter POSIX abbreviation for area |
| 39 | |
| 40 | * For additional information on how to build and run the tests in this |
| 41 | suite, see Documentation/HOWTO_RunTests. |
| 42 | |
| 43 | ========================== |
| 44 | Documentation & Resources |
| 45 | ========================== |
| 46 | |
| 47 | POSIX* Test Suite project page: http://posixtest.sf.net |
| 48 | |
| vapier | 22858b2 | 2006-05-21 23:47:08 +0000 | [diff] [blame^] | 49 | BUILD - describes how to set up your machine to build and test |
| 50 | LDFLAGS - File that Makefile uses to link to what you specify |
| robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 51 | |
| 52 | The following files give developers information on how to write test |
| 53 | cases for the project (under Documentation): |
| 54 | |
| vapier | 22858b2 | 2006-05-21 23:47:08 +0000 | [diff] [blame^] | 55 | HOWTO_Assertions - describes format of the assertions files used to |
| 56 | map test case descriptions to test cases |
| 57 | HOWTO_BoundaryTest - information about testing boundary conditions |
| 58 | HOWTO_CodingGuidelines - describes coding guidelines for this project |
| 59 | HOWTO_Coverage - describes format of COVERAGE.<area> files |
| 60 | HOWTO_DefinitionsTest - ideas behind testing POSIX header files |
| 61 | HOWTO_ResultCodes - standardized return codes for tests |
| 62 | HOWTO_Tagging - describes how to tag files for inclusion in a release |
| 63 | HOWTO_RunTests - describes how to build and run the tests |
| robbiew | 0dc0765 | 2005-06-03 16:29:48 +0000 | [diff] [blame] | 64 | |
| 65 | ** POSIX (R) is a registered trademark of the IEEE |
| 66 | |
| vapier | 22858b2 | 2006-05-21 23:47:08 +0000 | [diff] [blame^] | 67 | Maintainer: Ling Yu (ling.l.yu@intel.com) |