1 COVERAGE FILES 2 ============== 3 4 Every area of the POSIX spec that has tests written for it should be tracked by 5 a corresponding COVERAGE.<area> file in the Documentation directory. The first 6 example file is COVERAGE.timers, which I will keep up to date with the latest 7 format. 8 9 The idea with these files is to track the progress of test creation. Also, the 10 files will be parsed nightly to generate the Project Status web page at 11 http://posixtest.sf.net/status.html so they must conform to a certain format. 12 13 To simplify the creation of a tool to parse these files, the following rules 14 should be observed in creating the file. 15 16 Completion of POSIX Function Conformance Tests 17 ---------------------------------------------- 18 There should be one line for each POSIX function included in this area of the 19 POSIX spec. The tests for these functions are currently found in the 20 conformance/behavior/<function-name> directory. (They may be moved to 21 conformance/interfaces/<function-name> shortly.) The function test directory 22 need not exist yet, but the list of functions in the COVERAGE file should be 23 complete. 24 25 Each line should have this format: 26 <function-name> <complete?> <other-fields> 27 28 That is, spaces or tabs as whitespace separating the function name and complete 29 fields, and any other fields, if present. Other fields will be ignored by the 30 parser currently. 31 32 For example, from COVERAGE.timers: 33 clock_gettime NO* MED 34 35 Only the first letter of the complete? field will be read, and should be either 36 N or Y. (So you are free to have asterisks as Julie has done.) 37 38 She has a priority field after that HIGH/MED/LOW which is currently not used by 39 the parser. 40 41 Information Fields 42 ------------------ 43 Additional information should be provided with this format: 44 Field-Name: Value-Data 45 46 The field "Coverage-Area" MUST be provided with a description of this area of 47 the POSIX spec such as "Clocks & Timers (TMR)". 48 49 The field "Area-Code" MUST be provided, a unique code with no spaces to use 50 internally within the web page to link to the stats about this coverage area, 51 such as "tmr" or "sig". 52 53 The field "Maintainer" SHOULD be provided with the name of the active 54 maintainer of this area. 55 56 The field "Contributor" MAY be provided (one or more times) with a name of 57 someone who contributed to the tests in this area (other than the active 58 maintainer). 59 60 Comment Lines 61 ------------- 62 Any line that is not of the type defined above must be denoted as a comment 63 line. There are three types of comment lines that will be ignored: 64 65 - Any blank line or line with whitespace only 66 - Any line beginning with // 67 - Any lines between an opening line of /* and a closing line of */ (inclusive) 68 69 For example, only the clock_gettime line would be parsed below: 70 71 // SAMPLE FILE: First Line 72 73 // The line above is whitespace only, and the line below is blank 74 75 /* 76 This section is for longer 77 comments. 78 */ 79 clock_gettime NO* MED 80 81 // SAMPLE FILE: Last Line 82 83 Other Tests: Definitions, Functional, Stress, etc. 84 -------------------------------------------------- 85 These tests are not currently handled by the parser tool, and thus should be 86 included in comment fields if the information is present. 87 88 Future Extensions 89 ----------------- 90 If other fields become required later, they will be moved to the front of the 91 text lines, so that optional fields can still appear after them. 92 93 Contributors: geoffrey.r.gustafson REMOVE-THIS AT intel DOT com 94
