doc/send-pr.texinfo

   1 In any complex software, there will be bugs.  If you have successfully
   2 built and installed @value{PRODUCT}, please use the @code{krb5-send-pr}
   3 program to fill out a Problem Report should you encounter any errors in
   4 our software.
   5
   6 Bug reports that include proposed fixes are especially welcome.  If you
   7 do include fixes, please send them using either context diffs or unified
   8 diffs (using @samp{diff -c} or @samp{diff -u}, respectively).  Please be
   9 careful when using ``cut and paste'' or other such means to copy a patch
  10 into a bug report; depending on the system being used, that can result
  11 in converting TAB characters into spaces, which makes applying the
  12 patches more difficult.
  13
  14 The @code{krb5-send-pr} program is installed in the directory
  15 @code{@value{ROOTDIR}/sbin}.
  16
  17 The @code{krb5-send-pr} program enters the problem report into our
  18 Problem Report Management System (PRMS), which automatically assigns it
  19 to the engineer best able to help you with problems in the assigned
  20 category.
  21 @ifset CYGNUS
  22 The engineer will work with you via email, telephone, or both, and all
  23 email related to this Problem Report will be tracked by PRMS for future
  24 reference.  If you need to talk to someone else in our organization
  25 about the problem (@i{e.g.}, if the engineer gets hit by a truck), we
  26 can find out what the current state is through the PR number.
  27 @end ifset
  28
  29 The @code{krb5-send-pr} program will try to intelligently fill in as
  30 many fields as it can.  You need to choose the @dfn{category},
  31 @dfn{class}, @dfn{severity}, and @dfn{priority} of the problem, as well
  32 as giving us as much information as you can about its exact nature.
  33
  34 @need 1000
  35 The PR @b{category} will be one of:
  36
  37 @smallexample
  38 @group
  39 krb5-admin   krb5-appl    krb5-build   krb5-clients
  40 krb5-doc     krb5-kdc     krb5-libs    krb5-misc
  41 pty          telnet       test
  42 @end group
  43 @end smallexample
  44
  45 @noindent
  46 Choose the category that best describes the area under which your
  47 problem falls.
  48
  49 The @b{class} can be @dfn{sw-bug}, @dfn{doc-bug}, @dfn{change-request},
  50 or @dfn{support}.  The first two are exactly as their names imply.  Use
  51 @i{change-request} when the software is behaving according to
  52 specifications, but you want to request changes in some feature or
  53 behavior.  The @i{support} class is intended for more general questions
  54 about building or using @value{PRODUCT}.
  55
  56 The @b{severity} of the problem indicates the problem's impact on the
  57 usability of @value{PRODUCT}.  If a problem is @dfn{critical}, that
  58 means the product, component or concept is completely non-operational,
  59 or some essential functionality is missing, and no workaround is known.
  60 A @dfn{serious} problem is one in which the product, component or
  61 concept is not working properly or significant functionality is missing.
  62 Problems that would otherwise be considered @i{critical} are rated
  63 @i{serious} when a workaround is known.  A @dfn{non-critical} problem is
  64 one that is indeed a problem, but one that is having a minimal effect on
  65 your ability to use @value{PRODUCT}.  @i{E.g.}, The product, component
  66 or concept is working in general, but lacks features, has irritating
  67 behavior, does something wrong, or doesn't match its documentation.  The
  68 default severity is @i{serious}.
  69
  70 The @b{priority} indicates how urgent this particular problem is in
  71 relation to your work.  Note that low priority does not imply low
  72 importance.
  73 @ifset CYGNUS
  74 @value{COMPANY} considers all problems important, and
  75 encourages its customers to be realistic about priority ratings.
  76 @end ifset
  77 A priority of @dfn{high} means a solution is needed as soon as possible.
  78 A priority of @dfn{medium} means the problem should be solved no later
  79 than the next release.  A priority of @dfn{low} means the problem should
  80 be solved in a future release, but it is not important to your work how
  81 soon this happens.  The default priority is @i{medium}.
  82
  83 Note that a given severity does not necessarily imply a given priority.
  84 For example, a non-critical problem might still have a high priority if
  85 you are faced with a hard deadline.  Conversely, a serious problem might
  86 have a low priority if the feature it is disabling is one that you do
  87 not need.
  88
  89 It is important that you fill in the @i{release} field and tell us
  90 what changes you have made, if any.
  91
  92 @iftex
  93 @vfill
  94 @end iftex
  95
  96 @page
  97 A sample filled-out form from a company named ``Toasters, Inc.'' might
  98 look like this:
  99
 100 @smallexample
 101 @group
 102 To: krb5-bugs@@mit.edu
 103 Subject: misspelled "Kerberos" in title of installation guide
 104 From: jcb
 105 Reply-To: jcb
 106 Cc:
 107 X-send-pr-version: 3.99
 108
 109
 110 >Submitter-Id:  mit
 111 >Originator:    Jeffrey C. Gilman Bigler
 112 >Organization:
 113 mit
 114 >Confidential:  no
 115 >Synopsis:      Misspelled "Kerberos" in title of installation guide
 116 >Severity:      non-critical
 117 >Priority:      low
 118 >Category:      krb5-doc
 119 >Class:         doc-bug
 120 >Release:       1.0-development
 121 >Environment:
 122         <machine, os, target, libraries (multiple lines)>
 123 System: ULTRIX imbrium 4.2 0 RISC
 124 Machine: mips
 125 >Description:
 126         Misspelled "Kerberos" in title of "Kerboros V5 Installation Guide"
 127 >How-To-Repeat:
 128         N/A
 129 >Fix:
 130         Correct the spelling.
 131 @end group
 132 @end smallexample
 133
 134 @iftex
 135 @vfill
 136 @end iftex
 137
 138 If the @code{krb5-send-pr} program does not work for you, or if you did
 139 not get far enough in the process to have an installed and working
 140 @code{krb5-send-pr}, you can generate your own form, using the above as
 141 an example.
 142
 143
 144