annotate man/gnats/fields.texi @ 112:48d667d6f17f r20-1b8

Import from CVS: tag r20-1b8
author cvs
date Mon, 13 Aug 2007 09:20:48 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
112
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
1 @node Fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
2 @section Problem Report format
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
3 @cindex Problem Report format
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
4 @cindex format
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
5 @cindex database similarities
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
6 @cindex fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
7
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
8 The format of a PR is designed to reflect the nature of @sc{gnats} as a
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
9 database. Information is arranged into @dfn{fields}, and kept in
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
10 individual records (Problem Reports).
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
11
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
12 Problem Report fields are denoted by a keyword which begins with
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
13 @samp{>} and ends with @samp{:}, as in @samp{>Confidential:}. Fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
14 belong to one of three data types:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
15
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
16 @table @asis
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
17 @cindex Problem Report data types
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
18 @cindex @emph{Enumerated} data types
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
19 @item @sc{Enumerated}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
20 One of a specific set of values, which vary according to the field. The
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
21 value for each keyword must be on the same line as the keyword. These
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
22 values are not configurable (yet).
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
23
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
24 @ifset SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
25 For each @sc{Enumerated} keyword, the possible choices are listed in the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
26 @code{send-pr} template as a comment.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
27 @end ifset
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
28 The following fields are @sc{Enumerated} format; see the descriptions of
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
29 fields below for explanations of each field in detail:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
30
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
31 @smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
32 @group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
33 >Confidential: >Severity: >Priority:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
34 >Class: >State: >Number:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
35 @end group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
36 @end smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
37
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
38 @cindex @emph{Text} data types
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
39 @item @sc{Text}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
40 One single line of text which must begin and end on the same line (i.e.,
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
41 before a newline) as the keyword. See the descriptions of fields below
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
42 for explanations of each field in detail. The following fields are
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
43 @sc{Text} format:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
44
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
45 @smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
46 @group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
47 >Submitter-Id: >Originator: >Synopsis:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
48 >Category: >Release: >Responsible:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
49 >Arrival-Date:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
50 @end group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
51 @end smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
52
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
53 @cindex @emph{MultiText} data types
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
54 @item @sc{MultiText}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
55 Text of any length may occur in this field. @sc{MultiText} may span
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
56 multiple lines and may also include blank lines. A @sc{MultiText} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
57 ends only when another keyword appears. See the descriptions of fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
58 below for explanations of each field in detail.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
59
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
60 The following fields are @sc{MultiText} format:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
61
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
62 @smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
63 @group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
64 >Organization: >Environment: >Description:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
65 >How-To-Repeat: >Fix: >Audit-Trail:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
66 >Unformatted:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
67 @end group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
68 @end smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
69
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
70 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
71
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
72 A Problem Report contains two different types of fields: @dfn{Mail
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
73 Header} fields, which are used by the mail handler for delivery, and
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
74 @dfn{Problem Report} fields, which contain information relevant to the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
75 Problem Report and its submitter. A Problem Report is essentially a
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
76 specially formatted electronic mail message.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
77
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
78 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
79 @subheading Example Problem Report
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
80 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
81
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
82 The following is an example Problem Report. Mail headers are at the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
83 top, followed by @sc{gnats} fields, which begin with @samp{>} and end
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
84 with @samp{:}. The @samp{Subject:} line in the mail header and the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
85 @samp{>Synopsis:} field are usually duplicates of each other.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
86
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
87 @cindex sample Problem Report
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
88 @cindex example Problem Report
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
89 @cindex Problem Report template
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
90 @cartouche
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
91 @smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
92 @group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
93 Message-Id: @var{message-id}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
94 Date: @var{date}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
95 From: @var{address}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
96 Reply-To: @var{address}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
97 To: @var{bug-address}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
98 Subject: @var{subject}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
99
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
100 >Number: @var{gnats-id}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
101 >Category: @var{category}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
102 >Synopsis: @var{synopsis}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
103 >Confidential: yes @emph{or} no
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
104 >Severity: critical, serious, @emph{or} non-critical
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
105 >Priority: high, medium @emph{or} low
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
106 >Responsible: @var{responsible}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
107 >State: open, analyzed, suspended, feedback, @emph{or} closed
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
108 >Class: sw-bug, doc-bug, change-request, support,
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
109 @ifset SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
110 @emph{or} duplicate
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
111 @end ifset
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
112 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
113 duplicate, @emph{or} mistaken
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
114 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
115 >Submitter-Id: @var{submitter-id}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
116 >Arrival-Date: @var{date}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
117 >Originator: @var{name}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
118 >Organization: @var{organization}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
119 >Release: @var{release}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
120 >Environment:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
121 @var{environment}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
122 >Description:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
123 @var{description}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
124 >How-To-Repeat:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
125 @var{how-to-repeat}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
126 >Fix:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
127 @var{fix}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
128 >Audit-Trail:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
129 @var{appended-messages@dots{}}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
130 State-Changed-From-To: @var{from}-@var{to}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
131 State-Changed-When: @var{date}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
132 State-Changed-Why:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
133 @var{reason}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
134 Responsible-Changed-From-To: @var{from}-@var{to}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
135 Responsible-Changed-When: @var{date}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
136 Responsible-Changed-Why:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
137 @var{reason}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
138 >Unformatted:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
139 @var{miscellaneous}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
140 @end group
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
141 @end smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
142 @end cartouche
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
143
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
144 @menu
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
145 * Mail header fields::
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
146 * Problem Report fields::
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
147 @end menu
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
148
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
149 @c ----------------------
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
150 @node Mail header fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
151 @subsection Mail header fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
152 @cindex mail header fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
153 @cindex Internet standard RFC-822
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
154
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
155 A Problem Report may contain any mail header field described in the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
156 Internet standard RFC-822. However, only the fields which identify the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
157 sender and the subject are required by @code{send-pr}:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
158
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
159 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
160 @cindex @code{To:} header
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
161 @item To:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
162 The preconfigured mail address for the Support Site where the PR is to
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
163 be sent, automatically supplied by @code{send-pr}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
164
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
165 @cindex @code{Subject:} header
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
166 @item Subject:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
167 A terse description of the problem. This field normally contains the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
168 same information as the @samp{>Synopsis:} field.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
169
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
170 @cindex @code{From:} header
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
171 @item From:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
172 Usually supplied automatically by the originator's mailer; should
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
173 contain the originator's electronic mail address.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
174
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
175 @cindex @code{Reply-To:} header
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
176 @item Reply-To:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
177 A return address to which electronic replies can be sent; in most cases,
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
178 the same address as the @code{From:} field.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
179 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
180
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
181 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
182 @cindex @code{Received-By:} headers
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
183 One of the configurable options for @sc{gnats} is whether or not to
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
184 retain @w{@samp{Received-By:}} headers, which often consume a lot of
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
185 space and are not often used. @xref{Local configuration,,Changing your
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
186 local configuration}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
187 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
188
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
189 @c ----------------------
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
190 @node Problem Report fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
191 @subsection Problem Report fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
192 @cindex GNATS database fields
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
193 @cindex field format
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
194
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
195 @c FIXME - this node is loooooooooooooooong...
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
196
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
197 @subheading Field descriptions
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
198
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
199 The following fields are present whenever a PR is submitted via the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
200 program @code{send-pr}. @sc{gnats} adds additional fields when the PR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
201 arrives at the Support Site; explanations of these follow this list.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
202
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
203 @cindex fields - list
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
204 @cindex GNATS fields - list
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
205 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
206 @cindex @code{Submitter-Id} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
207 @cindex @code{>Submitter-Id:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
208 @item >Submitter-Id:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
209 (@sc{Text}) A unique identification code assigned by the Support Site.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
210 It is used to identify all Problem Reports coming from a particular
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
211 site. (Submitters without a value for this field can invoke
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
212 @code{send-pr} with the @samp{--request-id} option to apply for one from
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
213 the support organization. Problem Reports from those not affiliated
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
214 with the support organization should use the default value of @samp{net}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
215 for this field.)
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
216
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
217 @cindex @code{Originator} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
218 @cindex @code{>Originator:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
219 @item >Originator:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
220 (@sc{Text}) Originator's real name. The default is the value of the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
221 originator's environment variable @code{NAME}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
222
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
223 @cindex @code{>Organization:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
224 @cindex @code{Organization} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
225 @item >Organization:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
226 (@sc{MultiText}) The originator's organization. The default value is
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
227 set with the variable @w{@code{DEFAULT_ORGANIZATION}} in the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
228 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
229 @file{config} file (@pxref{config,,The @code{config} file}).
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
230 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
231 @ifset SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
232 @code{send-pr} shell script.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
233 @end ifset
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
234
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
235 @cindex @code{Confidential} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
236 @cindex @code{>Confidential:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
237 @cindex confidentiality in PRs
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
238 @cindex PR confidentiality
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
239 @item >Confidential:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
240 (@sc{Enumerated}) Use of this field depends on the originator's
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
241 relationship with the support organization; contractual agreements often
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
242 have provisions for preserving confidentiality. Conversely, a lack of a
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
243 contract often means that any data provided will not be considered
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
244 confidential. Submitters should be advised to contact the support
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
245 organization directly if this is an issue.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
246
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
247 If the originator's relationship to the support organization provides
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
248 for confidentiality, then if the value of this field is @samp{yes} the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
249 support organization treats the PR as confidential; any code samples
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
250 provided are not made publicly available (e.g., in regression test
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
251 suites). The default value is @samp{yes}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
252
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
253 @cindex @code{Synopsis} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
254 @cindex @code{>Synopsis:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
255 @item >Synopsis:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
256 (@sc{Text}) One-line summary of the problem. @w{@code{send-pr}} copies
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
257 this information to the @samp{Subject:} line when you submit a Problem
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
258 Report.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
259
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
260 @cindex @code{Severity} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
261 @cindex @code{>Severity:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
262 @item >Severity:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
263 (@sc{Enumerated}) The severity of the problem. Accepted values include:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
264
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
265 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
266 @cindex @emph{critical} severity problems
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
267 @item critical
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
268 The product, component or concept is completely non-operational or some
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
269 essential functionality is missing. No workaround is known.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
270
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
271 @cindex @emph{serious} severity problems
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
272 @item serious
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
273 The product, component or concept is not working properly or significant
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
274 functionality is missing. Problems that would otherwise be considered
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
275 @samp{critical} are rated @samp{serious} when a workaround is known.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
276
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
277 @cindex @emph{non-critical} severity problems
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
278 @item non-critical
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
279 The product, component or concept is working in general, but lacks
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
280 features, has irritating behavior, does something wrong, or doesn't
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
281 match its documentation.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
282 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
283 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
284 The default value is @samp{serious}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
285 @sp 1
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
286
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
287 @cindex @code{Priority} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
288 @cindex @code{>Priority:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
289 @item >Priority:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
290 (@sc{Enumerated}) How soon the originator requires a solution. Accepted
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
291 values include:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
292
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
293 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
294 @cindex @emph{high} priority problems
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
295 @item high
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
296 A solution is needed as soon as possible.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
297
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
298 @cindex @emph{medium} priority problems
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
299 @item medium
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
300 The problem should be solved in the next release.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
301
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
302 @cindex @emph{low} priority problems
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
303 @item low
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
304 The problem should be solved in a future release.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
305 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
306 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
307 The default value is @samp{medium}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
308 @sp 1
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
309
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
310 @cindex @code{Category} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
311 @cindex @code{>Category:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
312 @item >Category:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
313 (@sc{Text}) The name of the product, component or concept where
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
314 the problem lies. The values for this field are defined by the Support
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
315 Site.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
316 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
317 @xref{categories,,The @code{categories} file}, for details.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
318 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
319
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
320 @cindex @code{Class} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
321 @cindex @code{>Class:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
322 @item >Class:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
323 (@sc{Enumerated}) The class of a problem can be one of the following:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
324
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
325 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
326 @cindex @emph{sw-bug} class
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
327 @item sw-bug
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
328 A general product problem. (@samp{sw} stands for ``software''.)
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
329
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
330 @cindex @emph{doc-bug} class
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
331 @item doc-bug
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
332 A problem with the documentation.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
333
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
334 @cindex @emph{change-request} class
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
335 @item change-request
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
336 A request for a change in behavior, etc.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
337
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
338 @cindex @emph{support} class
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
339 @item support
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
340 A support problem or question.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
341
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
342 @cindex @emph{duplicate} class
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
343 @item duplicate (@var{pr-number})
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
344 Duplicate PR. @var{pr-number} should be the number of the original PR.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
345
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
346 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
347 @cindex @emph{mistaken} class
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
348 @item mistaken
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
349 No problem, user error or misunderstanding. This value is valid only at
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
350 the Support Site.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
351 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
352 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
353
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
354 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
355 The default is @samp{sw-bug}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
356 @sp 1
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
357
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
358 @cindex @code{Release} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
359 @cindex @code{>Release:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
360 @item >Release:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
361 (@sc{Text}) Release or version number of the product, component or
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
362 concept.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
363
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
364 @cindex @code{Environment} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
365 @cindex @code{>Environment:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
366 @item >Environment:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
367 (@sc{MultiText}) Description of the environment where the problem occured:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
368 machine architecture, operating system, host and target types,
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
369 libraries, pathnames, etc.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
370
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
371 @cindex @code{Description} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
372 @cindex @code{>Description:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
373 @item >Description:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
374 (@sc{MultiText}) Precise description of the problem.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
375
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
376 @cindex @code{How-To-Repeat} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
377 @cindex @code{>How-To-Repeat:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
378 @item >How-To-Repeat:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
379 (@sc{MultiText}) Example code, input, or activities to reproduce the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
380 problem. The support organization uses example code both to reproduce
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
381 the problem and to test whether the problem is fixed. Include all
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
382 preconditions, inputs, outputs, conditions after the problem, and
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
383 symptoms. Any additional important information should be included.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
384 Include all the details that would be necessary for someone else to
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
385 recreate the problem reported, however obvious. Sometimes seemingly
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
386 arbitrary or obvious information can point the way toward a solution.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
387 See also @ref{Helpful hints,,Helpful hints}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
388
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
389 @cindex @code{Fix} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
390 @cindex @code{>Fix:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
391 @item >Fix:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
392 (@sc{MultiText}) A description of a solution to the problem, or a patch
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
393 which solves the problem. (This field is most often filled in at the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
394 Support Site; we provide it to the submitter in case she has solved the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
395 problem.)
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
396
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
397 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
398
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
399 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
400 @sc{gnats} adds the following fields when the PR arrives at the Support
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
401 Site:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
402
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
403 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
404 @cindex @code{Number} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
405 @cindex @code{>Number:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
406 @item >Number:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
407 (@sc{Enumerated}) The incremental identification number for this PR.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
408 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
409 This is included in the automated reply to the submitter (if that
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
410 feature of @sc{gnats} is activated; @pxref{Local configuration,,Changing
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
411 your local configuration}). It is also included in the copy of the PR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
412 that is sent to the maintainer.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
413 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
414
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
415 The @samp{>Number:} field is often paired with the @samp{>Category:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
416 field as
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
417
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
418 @smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
419 @var{category}/@var{number}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
420 @end smallexample
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
421
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
422 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
423 in subsequent email messages. This is for historical reasons, as well
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
424 as because Problem Reports are stored in subdirectories which are named
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
425 by category.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
426
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
427 @cindex @code{State} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
428 @cindex @code{>State:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
429 @item >State:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
430 (@sc{Enumerated}) The current state of the PR. Accepted values are:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
431
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
432 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
433 @item open
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
434 The PR has been filed and the responsible person notified.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
435
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
436 @item analyzed
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
437 The responsible person has analyzed the problem.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
438
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
439 @item feedback
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
440 The problem has been solved, and the originator has been given a patch
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
441 or other fix.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
442
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
443 @item closed
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
444 The changes have been integrated, documented, and tested, and the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
445 originator has confirmed that the solution works.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
446
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
447 @item suspended
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
448 Work on the problem has been postponed.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
449 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
450
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
451 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
452 The initial state of a PR is @samp{open}. @xref{States,,States of
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
453 Problem Reports}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
454
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
455 @cindex @code{Responsible} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
456 @cindex @code{>Responsible:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
457 @item >Responsible:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
458 (@sc{Text}) The person responsible for this category.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
459 @ifclear SENDPR
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
460 @sc{gnats} retrieves this information from the @file{categories} file
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
461 (@pxref{categories,,The @code{categories} file}).
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
462 @end ifclear
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
463
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
464 @cindex @code{>Arrival-Date:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
465 @cindex @code{Arrival-Date} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
466 @item >Arrival-Date:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
467 (@sc{Text}) The time that this PR was received by @sc{gnats}. The date
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
468 is provided automatically by @sc{gnats}.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
469
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
470 @cindex @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
471 @cindex @code{Audit-Trail} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
472 @item >Audit-Trail:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
473 (@sc{MultiText}) Tracks related electronic mail as well as changes in
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
474 the @samp{>State:} and @samp{>Responsible:} fields with the sub-fields:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
475
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
476 @table @code
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
477 @cindex @code{State-Changed-<From>-<To>:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
478 @item @w{State-Changed-<From>-<To>: @var{oldstate}>-<@var{newstate}}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
479 The old and new @samp{>State:} field values.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
480
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
481 @cindex @code{Responsible-Changed-<From>-<To>:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
482 @item @w{Responsible-Changed-<From>-<To>: @var{oldresp}>-<@var{newresp}}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
483 The old and new @samp{>Responsible:} field values.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
484
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
485 @cindex @code{State-Changed-By:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
486 @cindex @code{Responsible-Changed-By:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
487 @item State-Changed-By: @var{name}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
488 @itemx Responsible-Changed-By: @var{name}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
489 The name of the maintainer who effected the change.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
490
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
491 @cindex @code{State-Changed-When:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
492 @cindex @code{Responsible-Changed-When:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
493 @item State-Changed-When: @var{timestamp}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
494 @itemx Responsible-Changed-When: @var{timestamp}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
495 The time the change was made.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
496
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
497 @cindex @code{State-Changed-Why:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
498 @cindex @code{Responsible-Changed-Why:} in @code{>Audit-Trail:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
499 @item State-Changed-Why: @var{reason@dots{}}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
500 @itemx Responsible-Changed-Why: @var{reason@dots{}}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
501 The reason for the change.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
502 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
503
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
504 @cindex subsequent mail
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
505 @cindex other mail
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
506 @cindex appending PRs
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
507 @cindex saving related mail
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
508 @cindex related mail
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
509 @noindent
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
510 The @samp{>Audit-Trail:} field also contains any mail messages received
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
511 by @sc{gnats} related to this PR, in the order received.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
512
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
513 @cindex @code{>Unformatted:}
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
514 @cindex @code{Unformatted} field
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
515 @item
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
516 >Unformatted:
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
517 (@sc{MultiText}) Any random text found outside the fields in the
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
518 original Problem Report.
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
519 @end table
48d667d6f17f Import from CVS: tag r20-1b8
cvs
parents:
diff changeset
520