Changes to gnats/doc/p-usage.texi

[Yngve Svendsen]

Index: gnats/doc/p-usage.texi
diff -c gnats/doc/p-usage.texi:1.9 gnats/doc/p-usage.texi:1.10
*** gnats/doc/p-usage.texi:1.9  Tue Oct 22 18:46:17 2002
--- gnats/doc/p-usage.texi      Thu Oct 24 07:38:25 2002
***************
*** 4,10 ****
  @cindex invoking the @sc{gnats} user tools
  
  This chapter describes the user tools distributed with @sc{gnats}.  The
! @sc{gnats} administrative and internal tools tools are described in
  @ref{Management,,@sc{gnats} Administration}. The user tools provide
  facilities for initial submission, querying and editing of Problem
  Reports:
--- 4,10 ----
  @cindex invoking the @sc{gnats} user tools
  
  This chapter describes the user tools distributed with @sc{gnats}.  The
! @sc{gnats} administrative and internal tools are described in
  @ref{Management,,@sc{gnats} Administration}. The user tools provide
  facilities for initial submission, querying and editing of Problem
  Reports:
***************
*** 91,117 ****
  
  You may edit any non-readonly fields in the database.  We recommend that
  you avoid deleting any information in the @sc{Text} and @sc{MultiText}
! fields (such as @samp{>Description:} and @samp{>How-To-Repeat:}
  (@pxref{Fields,,Problem Report format}).  We also recommend that you
! record the final solution to the problem in the @samp{>Fix:} field for
! future reference.
! 
! After the PR has been edited, the PR is then resubmitted to the
! database, and the index is updated (@pxref{index file,,The @code{index}
! file}).  For information on @code{pr-edit}, the main driver for
! @code{edit-pr}, see @ref{Internal utils,,Internal utilities}.
  
  If you change a field that requires a reason for the change, such as the
! @samp{>Responsible:} or @samp{>State:} fields in the default
! configuration, @code{edit-pr} prompts you to supply a reason for the
! change.  A message is then appended to the @samp{>Audit-Trail:} section
! of the PR with the changed values and the change reason.
  
  Depending on how the database is configured, editing various fields in
  the PR may also cause mail to be sent concerning these changes.  In the
! default configuration, any fields that generate @samp{>Audit-Trail:}
! entries will also cause a copy of the new @samp{>Audit-Trail:} message
! to be sent.
  
  @menu
  * edit-pr from the shell::  Invoking @code{edit-pr} from the shell
--- 91,120 ----
  
  You may edit any non-readonly fields in the database.  We recommend that
  you avoid deleting any information in the @sc{Text} and @sc{MultiText}
! fields (such as @code{Description} and @code{How-To-Repeat}
  (@pxref{Fields,,Problem Report format}).  We also recommend that you
! record the final solution to the problem in the @code{Fix} field for
! future reference.  Note that heavily customized installations of
! @sc{gnats} may have differently named fields, and sites using such
! installations should provide their own set of routines and instructions
! regarding how PRs should be treated throughout their life span.
! 
! After the PR has been edited, it is then resubmitted to the database,
! and the index is updated (@pxref{index file,,The @code{index} file}).
! For information on @code{pr-edit}, the main driver for @code{edit-pr},
! see @ref{Internal utils,,Internal utilities}.
  
  If you change a field that requires a reason for the change, such as the
! @code{Responsible} or @code{State} fields in the default configuration,
! @code{edit-pr} prompts you to supply a reason for the change.  A message
! is then appended to the @code{Audit-Trail} field of the PR with the
! changed values and the change reason.
  
  Depending on how the database is configured, editing various fields in
  the PR may also cause mail to be sent concerning these changes.  In the
! default configuration, any fields that generate @samp{Audit-Trail}
! entries will also cause a copy of the new @samp{Audit-Trail} message to
! be sent.
  
  @menu
  * edit-pr from the shell::  Invoking @code{edit-pr} from the shell
***************
*** 248,256 ****
  @code{query-pr} can also be accessed by electronic mail, if your version
  of @sc{gnats} is configured for this.  To use this feature, simply send
  mail to the address @address@hidden@@@var{your-site}}} with command
! line arguments or options in the @samp{Subject:} line of the mail
! header.  @sc{gnats} replies to your mail with the results of your query.
! The default settings for the @code{query-pr} mail server are
  
  @cindex the section on query-by-mail needs to be relocated
  @smallexample
--- 251,259 ----
  @code{query-pr} can also be accessed by electronic mail, if your version
  of @sc{gnats} is configured for this.  To use this feature, simply send
  mail to the address @address@hidden@@@var{your-site}}} with command
! line arguments or options in the @code{Subject} line of the mail header.
! @sc{gnats} replies to your mail with the results of your query.  The
! default settings for the @code{query-pr} mail server are
  
  @cindex the section on query-by-mail needs to be relocated
  @smallexample
***************
*** 258,265 ****
  @end smallexample
  
  @noindent
! To override the @samp{--state} parameter, specify
! @address@hidden@var{state}}} in the @code{Subject:} line of the mail
  header.  You can not query on confidential Problem Reports by mail.
  
  The usage for @code{query-pr} is:
--- 261,268 ----
  @end smallexample
  
  @noindent
! To override the @code{--state} parameter, specify
! @address@hidden@var{state}}} in the @code{Subject} line of the mail
  header.  You can not query on confidential Problem Reports by mail.
  
  The usage for @code{query-pr} is:
***************
*** 364,371 ****
  @end smallexample
  
  @noindent
! where @var{field} is one of @samp{Category}, @samp{Class},
! @samp{Responsible}, @samp{Submitter-Id}, or @samp{State}.
  
  @table @code
  @item --list-databases
--- 367,374 ----
  @end smallexample
  
  @noindent
! where @var{field} is one of @code{Category}, @code{Class},
! @code{Responsible}, @code{Submitter-Id}, or @code{State}.
  
  @table @code
  @item --list-databases
***************
*** 777,783 ****
  @end smallexample
  
  @noindent
! yields all PRs in the database whose @samp{>State:} values match either
  @samp{open} or @samp{analyzed} (@pxref{Regexps,,Querying using regular
  expressions}.  This search is useful as a daily report that lists all
  Problem Reports which require attention.
--- 780,786 ----
  @end smallexample
  
  @noindent
! yields all PRs in the database whose @code{State} values match either
  @samp{open} or @samp{analyzed} (@pxref{Regexps,,Querying using regular
  expressions}.  This search is useful as a daily report that lists all
  Problem Reports which require attention.