1f08c3bdfSopenharmony_ciASSERTIONS 2f08c3bdfSopenharmony_ci========== 3f08c3bdfSopenharmony_ci 4f08c3bdfSopenharmony_ciThis document defines the format of assertions as well as the information 5f08c3bdfSopenharmony_cicontained in the XML parameters. 6f08c3bdfSopenharmony_ci 7f08c3bdfSopenharmony_ciFormat 8f08c3bdfSopenharmony_ci------ 9f08c3bdfSopenharmony_ciThe general format of an assertion is: 10f08c3bdfSopenharmony_ci<assertion id="<#>" tag="<string>"> 11f08c3bdfSopenharmony_ci</assertion> 12f08c3bdfSopenharmony_ci 13f08c3bdfSopenharmony_ciID 14f08c3bdfSopenharmony_ci-- 15f08c3bdfSopenharmony_ciThe ID is a unique number corresponding to the test case number (see the 16f08c3bdfSopenharmony_ciREADME for more information). 17f08c3bdfSopenharmony_ci 18f08c3bdfSopenharmony_ciTag 19f08c3bdfSopenharmony_ci--- 20f08c3bdfSopenharmony_ciThe tag uses the conventions defined below. 21f08c3bdfSopenharmony_ci 22f08c3bdfSopenharmony_ciThe format of the tag is below. 23f08c3bdfSopenharmony_ciItems in <> are replaced with the correct values. 24f08c3bdfSopenharmony_ciItems in [] are optional. 25f08c3bdfSopenharmony_ci()+ means the pattern can repeat and occurs at least once 26f08c3bdfSopenharmony_ci(<type>:<source>:<start line>:<last line>)+ [pt:<POSIXtag>] 27f08c3bdfSopenharmony_ci 28f08c3bdfSopenharmony_citype - Refers to the type of source that the assertion was taken from. 29f08c3bdfSopenharmony_ci Valid values are: 30f08c3bdfSopenharmony_ci ref - For reference document (generally a POSIX specification) 31f08c3bdfSopenharmony_ci oth - For any other material (design documents, analysis of 32f08c3bdfSopenharmony_ci behavior, etc.) 33f08c3bdfSopenharmony_ci 34f08c3bdfSopenharmony_cisource - Refers to the source that the assertion was taken from. Valid 35f08c3bdfSopenharmony_ci values are: 36f08c3bdfSopenharmony_ci For ref: 37f08c3bdfSopenharmony_ci (Note: # refers to the document version number) 38f08c3bdfSopenharmony_ci XBD# - POSIX Base Definitions document 39f08c3bdfSopenharmony_ci XSH# - POSIX System Interfaces document 40f08c3bdfSopenharmony_ci XCU# - POSIX Shell and Utilities document 41f08c3bdfSopenharmony_ci XRAT# - POSIX Rationale document 42f08c3bdfSopenharmony_ci 43f08c3bdfSopenharmony_ci When dealing with Technical Corrigendums, append TC# where # refers to 44f08c3bdfSopenharmony_ci the technical corrigendum document number. 45f08c3bdfSopenharmony_ci 46f08c3bdfSopenharmony_ci e.g. XSH6TC1, XBDTC2, etc. 47f08c3bdfSopenharmony_ci 48f08c3bdfSopenharmony_ci For oth: 49f08c3bdfSopenharmony_ci user defined - Ideally should be short (1-3 letters) to define the 50f08c3bdfSopenharmony_ci source. 51f08c3bdfSopenharmony_ci 52f08c3bdfSopenharmony_cistart line/ - Refers to the first and last line in the source where the 53f08c3bdfSopenharmony_cilast line assertion is taken from. If the type is oth and there are no 54f08c3bdfSopenharmony_ci line numbers, this should be the page number (or 0 if no 55f08c3bdfSopenharmony_ci page numbers). 56f08c3bdfSopenharmony_ci 57f08c3bdfSopenharmony_ci Note: If you do not have access to the line numbers in 58f08c3bdfSopenharmony_ci the official POSIX Specs, then simply put in 59f08c3bdfSopenharmony_ci brackets an unofficial reference 60f08c3bdfSopenharmony_ci (ex. <section 3.4, third bullet>) 61f08c3bdfSopenharmony_ci 62f08c3bdfSopenharmony_cipt:<POSIXtag> - If the assertion is taken from a POSIX specification and there 63f08c3bdfSopenharmony_ci is a POSIX tag (pt) associated with it, the additional string 64f08c3bdfSopenharmony_ci pt:<POSIXtag> can designate this. <tag> is the three letter 65f08c3bdfSopenharmony_ci POSIX tag. 66f08c3bdfSopenharmony_ci 67f08c3bdfSopenharmony_ciContributors: geoffrey.r.gustafson REMOVE-THIS AT intel DOT com 68f08c3bdfSopenharmony_ci julie.n.fleischer REMOVE-THIS AT intel DOT com 69f08c3bdfSopenharmony_ci ajosey REMOVE-THIS AT rdg DOT opengroup DOT org 70f08c3bdfSopenharmony_ci rolla.n.selbak REMOVE-THIS AT intel DOT com 71