158 |
subject in the submitted PR: |
subject in the submitted PR: |
159 |
|
|
160 |
@table @code |
@table @code |
161 |
@cindex @code{To:} header |
@cindex @code{To} header |
162 |
@item To: |
@item To: |
163 |
The mail address for the Support Site, automatically supplied by the |
The mail address for the Support Site, automatically supplied by the |
164 |
tool used to submit the PR or by the originator if plain e-mail was |
tool used to submit the PR or by the originator if plain e-mail was |
165 |
used. |
used. |
166 |
|
|
167 |
@cindex @code{Subject:} header |
@cindex @code{Subject} header |
168 |
@item Subject: |
@item Subject: |
169 |
A terse description of the problem. This field normally contains the |
A terse description of the problem. This field normally contains the |
170 |
same information as the @samp{Synopsis} field. |
same information as the @samp{Synopsis} field. |
171 |
|
|
172 |
@cindex @code{From:} header |
@cindex @code{From} header |
173 |
@item From: |
@item From: |
174 |
Supplied automatically when PRs are submitted by plain e-mail and when |
Supplied automatically when PRs are submitted by plain e-mail and when |
175 |
well-behaved tools such as @code{send-pr} are used; should always |
well-behaved tools such as @code{send-pr} are used; should always |
176 |
contain the originator's e-mail address. |
contain the originator's e-mail address. |
177 |
|
|
178 |
@cindex @code{Reply-To:} header |
@cindex @code{Reply-To} header |
179 |
@item Reply-To: |
@item Reply-To: |
180 |
A return address to which electronic replies can be sent; in most cases, |
A return address to which electronic replies can be sent; in most cases, |
181 |
the same address as the @code{From:} field. |
the same address as the @code{From:} field. |
182 |
@end table |
@end table |
183 |
|
|
184 |
@ifclear SENDPR |
@ifclear SENDPR |
185 |
@cindex @code{Received-By:} headers |
@cindex @code{Received-By} headers |
186 |
One of the configurable options for @sc{gnats} is whether or not to |
One of the configurable options for @sc{gnats} is whether or not to |
187 |
retain @w{@samp{Received-By:}} headers, which often consume a lot of |
retain @w{@samp{Received-By:}} headers, which often consume a lot of |
188 |
space and are not often used. @xref{dbconfig file,,The dbconfig file}. |
space and are not often used. @xref{dbconfig file,,The dbconfig file}. |
215 |
@cindex GNATS fields - list |
@cindex GNATS fields - list |
216 |
@table @code |
@table @code |
217 |
@cindex @code{Submitter-Id} field |
@cindex @code{Submitter-Id} field |
218 |
@cindex @code{>Submitter-Id:} |
@cindex @code{>Submitter-Id} |
219 |
@item Submitter-Id |
@item Submitter-Id |
220 |
(@code{enumerated-in-file}) A unique identification code assigned by the |
(@code{enumerated-in-file}) A unique identification code assigned by the |
221 |
Support Site. It is used to identify all Problem Reports coming from a |
Support Site. It is used to identify all Problem Reports coming from a |
230 |
@end ifclear |
@end ifclear |
231 |
|
|
232 |
@cindex @code{Originator} field |
@cindex @code{Originator} field |
233 |
@cindex @code{>Originator:} |
@cindex @code{>Originator} |
234 |
@item Originator |
@item Originator |
235 |
(@code{text}) Originator's real name. Note that the Submitter and |
(@code{text}) Originator's real name. Note that the Submitter and |
236 |
Originator might not be the same person/entity in all cases. |
Originator might not be the same person/entity in all cases. |
237 |
|
|
238 |
@cindex @code{>Organization:} |
@cindex @code{>Organization} |
239 |
@cindex @code{Organization} field |
@cindex @code{Organization} field |
240 |
@item Organization |
@item Organization |
241 |
(@code{multitext}) The originator's organization. |
(@code{multitext}) The originator's organization. |
242 |
|
|
243 |
@cindex @code{Confidential} field |
@cindex @code{Confidential} field |
244 |
@cindex @code{>Confidential:} |
@cindex @code{>Confidential} |
245 |
@cindex confidentiality in PRs |
@cindex confidentiality in PRs |
246 |
@cindex PR confidentiality |
@cindex PR confidentiality |
247 |
@item Confidential |
@item Confidential |
258 |
provided are not made publicly available. |
provided are not made publicly available. |
259 |
|
|
260 |
@cindex @code{Synopsis} field |
@cindex @code{Synopsis} field |
261 |
@cindex @code{>Synopsis:} |
@cindex @code{>Synopsis} |
262 |
@item Synopsis |
@item Synopsis |
263 |
(@code{text}) One-line summary of the problem. @w{@code{send-pr}} copies |
(@code{text}) One-line summary of the problem. @w{@code{send-pr}} copies |
264 |
this information to the @samp{Subject:} line when you submit a Problem |
this information to the @samp{Subject:} line when you submit a Problem |
265 |
Report. |
Report. |
266 |
|
|
267 |
@cindex @code{Severity} field |
@cindex @code{Severity} field |
268 |
@cindex @code{>Severity:} |
@cindex @code{>Severity} |
269 |
@item Severity |
@item Severity |
270 |
(@code{enum}) The severity of the problem. By default, accepted |
(@code{enum}) The severity of the problem. By default, accepted |
271 |
values include: |
values include: |
291 |
@end table |
@end table |
292 |
|
|
293 |
@cindex @code{Priority} field |
@cindex @code{Priority} field |
294 |
@cindex @code{>Priority:} |
@cindex @code{>Priority} |
295 |
@item Priority |
@item Priority |
296 |
(@code{enumerated}) How soon the originator requires a solution. |
(@code{enumerated}) How soon the originator requires a solution. |
297 |
Accepted values include: |
Accepted values include: |
311 |
@end table |
@end table |
312 |
|
|
313 |
@cindex @code{Category} field |
@cindex @code{Category} field |
314 |
@cindex @code{>Category:} |
@cindex @code{>Category} |
315 |
@item Category |
@item Category |
316 |
(@code{enumerated-in-file}) The name of the product, component or |
(@code{enumerated-in-file}) The name of the product, component or |
317 |
concept where the problem lies. The values for this field are defined |
concept where the problem lies. The values for this field are defined |
321 |
@end ifclear |
@end ifclear |
322 |
|
|
323 |
@cindex @code{Class} field |
@cindex @code{Class} field |
324 |
@cindex @code{>Class:} |
@cindex @code{>Class} |
325 |
@item Class |
@item Class |
326 |
(@code{enumerated-in-file}) The class of a problem in a default |
(@code{enumerated-in-file}) The class of a problem in a default |
327 |
@sc{gnats} installation can be one of the following: |
@sc{gnats} installation can be one of the following: |
361 |
@end ifclear |
@end ifclear |
362 |
|
|
363 |
@cindex @code{Release} field |
@cindex @code{Release} field |
364 |
@cindex @code{>Release:} |
@cindex @code{>Release} |
365 |
@item Release |
@item Release |
366 |
(@code{text}) Release or version number of the product, component or |
(@code{text}) Release or version number of the product, component or |
367 |
concept. |
concept. |
368 |
|
|
369 |
@cindex @code{Environment} field |
@cindex @code{Environment} field |
370 |
@cindex @code{>Environment:} |
@cindex @code{>Environment} |
371 |
@item Environment |
@item Environment |
372 |
(@code{multitext}) Description of the environment where the problem |
(@code{multitext}) Description of the environment where the problem |
373 |
occurred: machine architecture, operating system, host and target types, |
occurred: machine architecture, operating system, host and target types, |
374 |
libraries, pathnames, etc. |
libraries, pathnames, etc. |
375 |
|
|
376 |
@cindex @code{Description} field |
@cindex @code{Description} field |
377 |
@cindex @code{>Description:} |
@cindex @code{>Description} |
378 |
@item Description |
@item Description |
379 |
(@code{multitext}) Precise description of the problem. |
(@code{multitext}) Precise description of the problem. |
380 |
|
|
381 |
@cindex @code{How-To-Repeat} field |
@cindex @code{How-To-Repeat} field |
382 |
@cindex @code{>How-To-Repeat:} |
@cindex @code{>How-To-Repeat} |
383 |
@item How-To-Repeat |
@item How-To-Repeat |
384 |
(@code{multitext}) Example code, input, or activities to reproduce the |
(@code{multitext}) Example code, input, or activities to reproduce the |
385 |
problem. The support organization uses example code both to reproduce |
problem. The support organization uses example code both to reproduce |
392 |
See also @ref{Helpful hints,,Helpful hints}. |
See also @ref{Helpful hints,,Helpful hints}. |
393 |
|
|
394 |
@cindex @code{Fix} field |
@cindex @code{Fix} field |
395 |
@cindex @code{>Fix:} |
@cindex @code{>Fix} |
396 |
@item Fix |
@item Fix |
397 |
(@code{multitext}) A description of a solution to the problem, or a |
(@code{multitext}) A description of a solution to the problem, or a |
398 |
patch which solves the problem. (This field is most often filled in at |
patch which solves the problem. (This field is most often filled in at |
406 |
|
|
407 |
@table @code |
@table @code |
408 |
@cindex @code{Number} field |
@cindex @code{Number} field |
409 |
@cindex @code{>Number:} |
@cindex @code{>Number} |
410 |
@item Number |
@item Number |
411 |
(@code{enumerated}) The incremental identification number for this PR. |
(@code{enumerated}) The incremental identification number for this PR. |
412 |
@ifclear SENDPR |
@ifclear SENDPR |
429 |
the original PR. |
the original PR. |
430 |
|
|
431 |
@cindex @code{State} field |
@cindex @code{State} field |
432 |
@cindex @code{>State:} |
@cindex @code{>State} |
433 |
@item State |
@item State |
434 |
(@code{enumerated}) The current state of the PR. In default @sc{gnats} |
(@code{enumerated}) The current state of the PR. In default @sc{gnats} |
435 |
installations, accepted values are: |
installations, accepted values are: |
460 |
Problem Reports}. |
Problem Reports}. |
461 |
|
|
462 |
@cindex @code{Responsible} field |
@cindex @code{Responsible} field |
463 |
@cindex @code{>Responsible:} |
@cindex @code{>Responsible} |
464 |
@item Responsible |
@item Responsible |
465 |
(@code{text}) The person at the Support Site who is responsible for this |
(@code{text}) The person at the Support Site who is responsible for this |
466 |
PR. |
PR. |
469 |
(@pxref{categories file,,The @code{categories} file}). |
(@pxref{categories file,,The @code{categories} file}). |
470 |
@end ifclear |
@end ifclear |
471 |
|
|
472 |
@cindex @code{>Arrival-Date:} |
@cindex @code{>Arrival-Date} |
473 |
@cindex @code{Arrival-Date} field |
@cindex @code{Arrival-Date} field |
474 |
@item Arrival-Date |
@item Arrival-Date |
475 |
(@code{date}) The time that this PR was received by @sc{gnats}. The |
(@code{date}) The time that this PR was received by @sc{gnats}. The |
476 |
date is provided automatically by @sc{gnats}. |
date is provided automatically by @sc{gnats}. |
477 |
|
|
478 |
@cindex @code{Date-Required:} |
@cindex @code{Date-Required} |
479 |
@cindex @code{Date-Required} field |
@cindex @code{Date-Required} field |
480 |
@item Date-Required |
@item Date-Required |
481 |
(@code{date}) The date by which a fix is required. This is up to the |
(@code{date}) The date by which a fix is required. This is up to the |
482 |
maintainers at the Support Site to determine, so this field is not |
maintainers at the Support Site to determine, so this field is not |
483 |
available until after the PR has been submitted. |
available until after the PR has been submitted. |
484 |
|
|
485 |
@cindex @code{>Audit-Trail:} |
@cindex @code{>Audit-Trail} |
486 |
@cindex @code{Audit-Trail} field |
@cindex @code{Audit-Trail} field |
487 |
@item Audit-Trail |
@item Audit-Trail |
488 |
(@code{multitext}) Tracks related electronic mail as well as changes in |
(@code{multitext}) Tracks related electronic mail as well as changes in |
527 |
to find a @var{category}/@var{number} at the beginning of the Subject |
to find a @var{category}/@var{number} at the beginning of the Subject |
528 |
field of received e-mail in order to be able to file it correctly. |
field of received e-mail in order to be able to file it correctly. |
529 |
|
|
530 |
@cindex @code{>Unformatted:} |
@cindex @code{>Unformatted} |
531 |
@cindex @code{Unformatted} field |
@cindex @code{Unformatted} field |
532 |
@item Unformatted |
@item Unformatted |
533 |
(@code{multitext}) Any random text found outside the fields in the |
(@code{multitext}) Any random text found outside the fields in the |