Changes to gnats/doc/fields.texi

[Milan Zamazal]

Index: gnats/doc/fields.texi
diff -c gnats/doc/fields.texi:1.3 gnats/doc/fields.texi:1.4
*** gnats/doc/fields.texi:1.3   Tue Oct  2 08:40:47 2001
--- gnats/doc/fields.texi       Mon May 20 08:23:43 2002
***************
*** 158,188 ****
  subject in the submitted PR:
  
  @table @code
! @cindex @code{To:} header
  @item To:
  The mail address for the Support Site, automatically supplied by the
  tool used to submit the PR or by the originator if plain e-mail was
  used.
  
! @cindex @code{Subject:} header
  @item Subject:
  A terse description of the problem.  This field normally contains the
  same information as the @samp{Synopsis} field.
  
! @cindex @code{From:} header
  @item From:
  Supplied automatically when PRs are submitted by plain e-mail and when
  well-behaved tools such as @code{send-pr} are used; should always
  contain the originator's e-mail address.
  
! @cindex @code{Reply-To:} header
  @item Reply-To:
  A return address to which electronic replies can be sent; in most cases,
  the same address as the @code{From:} field.
  @end table
  
  @ifclear SENDPR
! @cindex @code{Received-By:} headers
  One of the configurable options for @sc{gnats} is whether or not to
  retain @address@hidden:}} headers, which often consume a lot of
  space and are not often used.  @xref{dbconfig file,,The dbconfig file}.
--- 158,188 ----
  subject in the submitted PR:
  
  @table @code
! @cindex @code{To} header
  @item To:
  The mail address for the Support Site, automatically supplied by the
  tool used to submit the PR or by the originator if plain e-mail was
  used.
  
! @cindex @code{Subject} header
  @item Subject:
  A terse description of the problem.  This field normally contains the
  same information as the @samp{Synopsis} field.
  
! @cindex @code{From} header
  @item From:
  Supplied automatically when PRs are submitted by plain e-mail and when
  well-behaved tools such as @code{send-pr} are used; should always
  contain the originator's e-mail address.
  
! @cindex @code{Reply-To} header
  @item Reply-To:
  A return address to which electronic replies can be sent; in most cases,
  the same address as the @code{From:} field.
  @end table
  
  @ifclear SENDPR
! @cindex @code{Received-By} headers
  One of the configurable options for @sc{gnats} is whether or not to
  retain @address@hidden:}} headers, which often consume a lot of
  space and are not often used.  @xref{dbconfig file,,The dbconfig file}.
***************
*** 215,221 ****
  @cindex GNATS fields - list
  @table @code
  @cindex @code{Submitter-Id} field
! @cindex @code{>Submitter-Id:}
  @item Submitter-Id
  (@code{enumerated-in-file}) A unique identification code assigned by the
  Support Site.  It is used to identify all Problem Reports coming from a
--- 215,221 ----
  @cindex GNATS fields - list
  @table @code
  @cindex @code{Submitter-Id} field
! @cindex @code{>Submitter-Id}
  @item Submitter-Id
  (@code{enumerated-in-file}) A unique identification code assigned by the
  Support Site.  It is used to identify all Problem Reports coming from a
***************
*** 230,247 ****
  @end ifclear
  
  @cindex @code{Originator} field
! @cindex @code{>Originator:}
  @item Originator
  (@code{text}) Originator's real name.  Note that the Submitter and
  Originator might not be the same person/entity in all cases.
  
! @cindex @code{>Organization:}
  @cindex @code{Organization} field
  @item Organization
  (@code{multitext}) The originator's organization.
  
  @cindex @code{Confidential} field
! @cindex @code{>Confidential:}
  @cindex confidentiality in PRs
  @cindex PR confidentiality
  @item Confidential
--- 230,247 ----
  @end ifclear
  
  @cindex @code{Originator} field
! @cindex @code{>Originator}
  @item Originator
  (@code{text}) Originator's real name.  Note that the Submitter and
  Originator might not be the same person/entity in all cases.
  
! @cindex @code{>Organization}
  @cindex @code{Organization} field
  @item Organization
  (@code{multitext}) The originator's organization.
  
  @cindex @code{Confidential} field
! @cindex @code{>Confidential}
  @cindex confidentiality in PRs
  @cindex PR confidentiality
  @item Confidential
***************
*** 258,271 ****
  provided are not made publicly available.
  
  @cindex @code{Synopsis} field
! @cindex @code{>Synopsis:}
  @item Synopsis
  (@code{text}) One-line summary of the problem.  @address@hidden copies
  this information to the @samp{Subject:} line when you submit a Problem
  Report.
  
  @cindex @code{Severity} field
! @cindex @code{>Severity:}
  @item Severity
  (@code{enum}) The severity of the problem.  By default, accepted
  values include:
--- 258,271 ----
  provided are not made publicly available.
  
  @cindex @code{Synopsis} field
! @cindex @code{>Synopsis}
  @item Synopsis
  (@code{text}) One-line summary of the problem.  @address@hidden copies
  this information to the @samp{Subject:} line when you submit a Problem
  Report.
  
  @cindex @code{Severity} field
! @cindex @code{>Severity}
  @item Severity
  (@code{enum}) The severity of the problem.  By default, accepted
  values include:
***************
*** 291,297 ****
  @end table
  
  @cindex @code{Priority} field
! @cindex @code{>Priority:}
  @item Priority
  (@code{enumerated}) How soon the originator requires a solution.
  Accepted values include:
--- 291,297 ----
  @end table
  
  @cindex @code{Priority} field
! @cindex @code{>Priority}
  @item Priority
  (@code{enumerated}) How soon the originator requires a solution.
  Accepted values include:
***************
*** 311,317 ****
  @end table
  
  @cindex @code{Category} field
! @cindex @code{>Category:}
  @item Category
  (@code{enumerated-in-file}) The name of the product, component or
  concept where the problem lies.  The values for this field are defined
--- 311,317 ----
  @end table
  
  @cindex @code{Category} field
! @cindex @code{>Category}
  @item Category
  (@code{enumerated-in-file}) The name of the product, component or
  concept where the problem lies.  The values for this field are defined
***************
*** 321,327 ****
  @end ifclear
  
  @cindex @code{Class} field
! @cindex @code{>Class:}
  @item Class
  (@code{enumerated-in-file}) The class of a problem in a default
  @sc{gnats} installation can be one of the following:
--- 321,327 ----
  @end ifclear
  
  @cindex @code{Class} field
! @cindex @code{>Class}
  @item Class
  (@code{enumerated-in-file}) The class of a problem in a default
  @sc{gnats} installation can be one of the following:
***************
*** 361,385 ****
  @end ifclear
  
  @cindex @code{Release} field
! @cindex @code{>Release:}
  @item Release
  (@code{text}) Release or version number of the product, component or
  concept.
  
  @cindex @code{Environment} field
! @cindex @code{>Environment:}
  @item Environment
  (@code{multitext}) Description of the environment where the problem
  occurred: machine architecture, operating system, host and target types,
  libraries, pathnames, etc.
  
  @cindex @code{Description} field
! @cindex @code{>Description:}
  @item Description
  (@code{multitext}) Precise description of the problem.
  
  @cindex @code{How-To-Repeat} field
! @cindex @code{>How-To-Repeat:}
  @item How-To-Repeat
  (@code{multitext}) Example code, input, or activities to reproduce the
  problem.  The support organization uses example code both to reproduce
--- 361,385 ----
  @end ifclear
  
  @cindex @code{Release} field
! @cindex @code{>Release}
  @item Release
  (@code{text}) Release or version number of the product, component or
  concept.
  
  @cindex @code{Environment} field
! @cindex @code{>Environment}
  @item Environment
  (@code{multitext}) Description of the environment where the problem
  occurred: machine architecture, operating system, host and target types,
  libraries, pathnames, etc.
  
  @cindex @code{Description} field
! @cindex @code{>Description}
  @item Description
  (@code{multitext}) Precise description of the problem.
  
  @cindex @code{How-To-Repeat} field
! @cindex @code{>How-To-Repeat}
  @item How-To-Repeat
  (@code{multitext}) Example code, input, or activities to reproduce the
  problem.  The support organization uses example code both to reproduce
***************
*** 392,398 ****
  See also @ref{Helpful hints,,Helpful hints}.
  
  @cindex @code{Fix} field
! @cindex @code{>Fix:}
  @item Fix
  (@code{multitext}) A description of a solution to the problem, or a
  patch which solves the problem.  (This field is most often filled in at
--- 392,398 ----
  See also @ref{Helpful hints,,Helpful hints}.
  
  @cindex @code{Fix} field
! @cindex @code{>Fix}
  @item Fix
  (@code{multitext}) A description of a solution to the problem, or a
  patch which solves the problem.  (This field is most often filled in at
***************
*** 406,412 ****
  
  @table @code
  @cindex @code{Number} field
! @cindex @code{>Number:}
  @item Number
  (@code{enumerated}) The incremental identification number for this PR.
  @ifclear SENDPR
--- 406,412 ----
  
  @table @code
  @cindex @code{Number} field
! @cindex @code{>Number}
  @item Number
  (@code{enumerated}) The incremental identification number for this PR.
  @ifclear SENDPR
***************
*** 429,435 ****
  the original PR.
  
  @cindex @code{State} field
! @cindex @code{>State:}
  @item State
  (@code{enumerated}) The current state of the PR.  In default @sc{gnats}
  installations, accepted values are:
--- 429,435 ----
  the original PR.
  
  @cindex @code{State} field
! @cindex @code{>State}
  @item State
  (@code{enumerated}) The current state of the PR.  In default @sc{gnats}
  installations, accepted values are:
***************
*** 460,466 ****
  Problem Reports}.
  
  @cindex @code{Responsible} field
! @cindex @code{>Responsible:}
  @item Responsible
  (@code{text}) The person at the Support Site who is responsible for this
  PR.
--- 460,466 ----
  Problem Reports}.
  
  @cindex @code{Responsible} field
! @cindex @code{>Responsible}
  @item Responsible
  (@code{text}) The person at the Support Site who is responsible for this
  PR.
***************
*** 469,488 ****
  (@pxref{categories file,,The @code{categories} file}).
  @end ifclear
  
! @cindex @code{>Arrival-Date:}
  @cindex @code{Arrival-Date} field
  @item Arrival-Date
  (@code{date}) The time that this PR was received by @sc{gnats}.  The
  date is provided automatically by @sc{gnats}.
  
! @cindex @code{Date-Required:}
  @cindex @code{Date-Required} field
  @item Date-Required
  (@code{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.
  
! @cindex @code{>Audit-Trail:}
  @cindex @code{Audit-Trail} field
  @item Audit-Trail
  (@code{multitext}) Tracks related electronic mail as well as changes in
--- 469,488 ----
  (@pxref{categories file,,The @code{categories} file}).
  @end ifclear
  
! @cindex @code{>Arrival-Date}
  @cindex @code{Arrival-Date} field
  @item Arrival-Date
  (@code{date}) The time that this PR was received by @sc{gnats}.  The
  date is provided automatically by @sc{gnats}.
  
! @cindex @code{Date-Required}
  @cindex @code{Date-Required} field
  @item Date-Required
  (@code{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.
  
! @cindex @code{>Audit-Trail}
  @cindex @code{Audit-Trail} field
  @item Audit-Trail
  (@code{multitext}) Tracks related electronic mail as well as changes in
***************
*** 527,533 ****
  to find a @var{category}/@var{number} at the beginning of the Subject
  field of received e-mail in order to be able to file it correctly.
  
! @cindex @code{>Unformatted:}
  @cindex @code{Unformatted} field
  @item Unformatted
  (@code{multitext}) Any random text found outside the fields in the
--- 527,533 ----
  to find a @var{category}/@var{number} at the beginning of the Subject
  field of received e-mail in order to be able to file it correctly.
  
! @cindex @code{>Unformatted}
  @cindex @code{Unformatted} field
  @item Unformatted
  (@code{multitext}) Any random text found outside the fields in the