Node:Problem Report fields, Previous:Mail header fields, Up:Fields
In a standard GNATS installation, certain fields will always be
present in a Problem Report. If a PR arrives without one or more of
these fields, GNATS will add them, and if they have default
values set by the configuration at the Support Site, they will be
filled in with these values. Certain tools such as
set up to provide sensible defaults for most fields
(see The send-pr.conf configuration file.)
In the list below, the field type (
enumerated, etc.) is supplied in parantheses. The different
field types are explained briefly in Field datatypes reference.
enumerated-in-file) A unique identification code assigned by the Support Site. It is used to identify all Problem Reports coming from a particular site. Submitters without a value for this field can invoke
--request-idoption to apply for one from the support organization. Problem Reports from those not affiliated with the support organization should use the default value of
netfor this field.
submitters file, for details.
text) Comma-separated list of e-mail-addresses of people to notify when the PR changes significantly, i.e. when the Audit-Trail changes. This list is independent from the Notify subfield of entries in the
categoriesfile of the GNATS database.
text) Originator's real name. Note that the Submitter and Originator might not be the same person/entity in all cases.
multitext) The originator's organization.
enum) Use of this field depends on the originator's relationship with the support organization; contractual agreements often have provisions for preserving confidentiality. Conversely, a lack of a contract often means that any data provided will not be considered confidential. Submitters should be advised to contact the support organization directly if this is an issue.
If the originator's relationship to the support organization provides
for confidentiality, then if the value of this field is
support organization treats the PR as confidential; any code samples
provided are not made publicly available.
text) One-line summary of the problem.
send-prcopies this information to the
Subjectline when you submit a Problem Report.
enum) The severity of the problem. By default, accepted values include:
criticalare usually rated
seriouswhen a workaround is known.
enumerated) How soon the originator requires a solution. Accepted values include:
enumerated-in-file) The name of the product, component or concept where the problem lies. The values for this field are defined by the Support Site. See The
categoriesfile, for details.
enumerated-in-file) The class of a problem in a default GNATS installation can be one of the following:
swstands for "software".)
classes file, for details.
text) Release or version number of the product, component or concept.
multitext) Description of the environment where the problem occurred: machine architecture, operating system, host and target types, libraries, pathnames, etc.
multitext) Precise description of the problem.
multitext) Example code, input, or activities to reproduce the problem. The support organization uses example code both to reproduce the problem and to test whether the problem is fixed. Include all preconditions, inputs, outputs, conditions after the problem, and symptoms. Any additional important information should be included. Include all the details that would be necessary for someone else to recreate the problem reported, however obvious. Sometimes seemingly arbitrary or obvious information can point the way toward a solution. See also Helpful hints.
multitext) A description of a solution to the problem, or a patch which solves the problem. (This field is most often filled in at the Support Site; we provide it to the submitter in case he or she has solved the problem.)
GNATS adds the following fields when the PR arrives at the Support Site:
enumerated) The incremental identification number for this PR. This is included in the automated reply to the submitter (if that feature of GNATS is activated; see The
dbconfigfile). It is also included in the copy of the PR that is sent to the maintainer.
Number field is often paired with the
in subsequent email messages. This is GNATS' way of tracking
followup messages that arrive by mail so that they are filed as part of
the original PR.
enumerated) The current state of the PR. In default GNATS installations, accepted values are:
The initial state of a PR is
open. See States of Problem Reports.
text) The person at the Support Site who is responsible for this PR. GNATS retrieves this information from the
categoriesfile (see The
date) The time that this PR was received by GNATS. The date is provided automatically by GNATS.
date) The date by which a fix is required. This is up to the maintainers at the Support Site to determine, so this field is not available until after the PR has been submitted.
multitext) Tracks related electronic mail as well as changes in the
Responsiblefields with the sub-fields:
Audit-Trail field also contains any mail messages received by
GNATS related to this PR, in the order received. GNATS needs
to find a category/number at the beginning of the Subject
field of received e-mail in order to be able to file it correctly.
multitext) Any random text found outside the fields in the original Problem Report.
During a Problem Report's journey from
Closed Date (both of type
date) will be added.