Changes to gnats/doc/fields.texi

[Yngve Svendsen]

Index: gnats/doc/fields.texi
diff -c gnats/doc/fields.texi:1.6 gnats/doc/fields.texi:1.7
*** gnats/doc/fields.texi:1.6   Thu Oct 24 07:38:25 2002
--- gnats/doc/fields.texi       Thu Oct 24 16:30:54 2002
***************
*** 33,39 ****
  present in a standard @sc{gnats} configuration.  Mail headers are at the
  top, followed by @sc{gnats} fields, which begin with @samp{>} and end
  with @samp{:}.  The @samp{Subject:} line in the mail header and the
! @samp{>Synopsis:} field are usually duplicates of each other.
  
  @cindex sample Problem Report
  @cindex example Problem Report
--- 33,39 ----
  present in a standard @sc{gnats} configuration.  Mail headers are at the
  top, followed by @sc{gnats} fields, which begin with @samp{>} and end
  with @samp{:}.  The @samp{Subject:} line in the mail header and the
! @code{Synopsis} field are usually duplicates of each other.
  
  @cindex sample Problem Report
  @cindex example Problem Report
***************
*** 214,220 ****
  @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
--- 214,219 ----
***************
*** 228,246 ****
  @xref{submitters file,,The @code{submitters} file}, for details.
  @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
--- 227,249 ----
  @xref{submitters file,,The @code{submitters} file}, for details.
  @end ifclear
  
+ @cindex @code{Notify-List} field
+ @item Notify-List
+ (@code{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 @file{categories} file of the @sc{gnats} database.
+ 
  @cindex @code{Originator} field
  @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} field
  @item Organization
  (@code{multitext}) The originator's organization.
  
  @cindex @code{Confidential} field
  @cindex confidentiality in PRs
  @cindex PR confidentiality
  @item Confidential
***************
*** 257,270 ****
  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 @code{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:
--- 260,271 ----
***************
*** 290,296 ****
  @end table
  
  @cindex @code{Priority} field
- @cindex @code{>Priority}
  @item Priority
  (@code{enumerated}) How soon the originator requires a solution.
  Accepted values include:
--- 291,296 ----
***************
*** 310,316 ****
  @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
--- 310,315 ----
***************
*** 320,326 ****
  @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:
--- 319,324 ----
***************
*** 360,384 ****
  @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
--- 358,378 ----
***************
*** 391,397 ****
  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
--- 385,390 ----
***************
*** 405,411 ****
  
  @table @code
  @cindex @code{Number} field
- @cindex @code{>Number}
  @item Number
  (@code{enumerated}) The incremental identification number for this PR.
  @ifclear SENDPR
--- 398,403 ----
***************
*** 428,434 ****
  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:
--- 420,425 ----
***************
*** 459,465 ****
  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.
--- 450,455 ----
***************
*** 468,474 ****
  (@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
--- 458,463 ----
***************
*** 481,487 ****
  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
--- 470,475 ----
***************
*** 526,532 ****
  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
--- 514,519 ----