gnu/usr.bin/send-pr/doc/states.texi

   1 @c $FreeBSD$
   2
   3 @node States
   4 @section States of Problem Reports
   5
   6 @cindex life-cycle of a Problem Report
   7 @cindex states of Problem Reports
   8 @cindex Problem Report states
   9 @cindex automatic notification
  10
  11 Each PR goes through a defined series of states between origination and
  12 closure.  The originator of a PR receives notification automatically of
  13 any state changes.
  14
  15 Unless your site has customized states (see @pxref{states
  16 file,,,gnats}), @sc{gnats} uses these states:
  17
  18 @table @dfn
  19 @cindex @emph{open} state
  20 @cindex initial state (@dfn{open})
  21 @cindex state---@dfn{open}
  22 @item open
  23 The initial state of a Problem Report.  This means the PR has been filed
  24 and the responsible person(s) notified.
  25
  26 @cindex @emph{analyzed} state
  27 @cindex state---@dfn{analyzed}
  28 @item analyzed
  29 The responsible person has analyzed the problem.  The analysis should
  30 contain a preliminary evaluation of the problem and an estimate of the
  31 amount of time and resources necessary to solve the problem.  It should
  32 also suggest possible workarounds.
  33
  34 @cindex @emph{feedback} state
  35 @cindex state---@dfn{feedback}
  36 @item feedback
  37 The problem has been solved, and the originator has been given a patch
  38 or other fix.  The PR remains in this state until the originator
  39 acknowledges that the solution works.
  40
  41 @cindex @emph{closed} state
  42 @cindex state---@dfn{closed}
  43 @cindex final state (@dfn{closed})
  44 @item closed
  45 A Problem Report is closed (``the bug stops here'') only when any
  46 changes have been integrated, documented, and tested, and the submitter
  47 has confirmed the solution.
  48
  49 @cindex @emph{suspended} state
  50 @cindex state---@dfn{suspended}
  51 @item suspended
  52 Work on the problem has been postponed.  This happens if a timely
  53 solution is not possible or is not cost-effective at the present time.
  54 The PR continues to exist, though a solution is not being actively
  55 sought.  If the problem cannot be solved at all, it should be closed
  56 rather than suspended.
  57 @end table
  58