Node:Individual field configuration, Next:Field datatypes, Previous:Overall database configuration, Up:dbconfig file
Each type of field in a PR must be described with a field
section
in the dbconfig
file. These sections have the following general
structure:
field "fieldname" { description "string" [ field-options ... ] datatype [ datatype-options ... ] [ on-change { edit-options ... } ] }
fieldname
is used as the field header in the PR. The characters >
and :
are used internally as field markers by GNATS, so they must
not be used in fieldnames.
The order in which the field
sections appear in the
dbconfig
file determines the order in which they appear in the PR
text. There is no required order, unlike previous versions of GNATS
-- the Unformatted field and multitext fields may appear anywhere in
the PR.
The following field-options
may be present within a field
section:
builtin-name "name"
GNATS has several fields which are required to be present in a PR, and this option is used to map their external descriptions to their internal usage. The external field names are:
number
category
synopsis
confidential
yes
, the PR is confidential
severity
priority
responsible
state
submitter
arrival-date
last-modified
audit-trail
For these built-in fields, a matching field description must appear in
the dbconfig
file. Otherwise, the configuration will be
considered invalid, and errors will be generated from the GNATS
clients and gnatsd.
description "description text"
--field-description
option in query-pr
.
This entry must be present in the field description, and there is no
default value.
query-default exact-regexp | inexact-regexp
^
search operator appears in a query, and
is also used for queries in query-pr
that use the old
--field
query options.
If the option is not given, the default search is exact-regexp
.
textsearch
--text
search from query-pr
. The field is
also flagged as a textsearch
field in the set of field flags
returned by the FIELDFLAGS
command in gnatsd.
By default, fields are not marked as textsearch
fields.
read-only
By default, editing is allowed.