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