doc/send-pr.texinfo

   1 If you have problems installing @value{PRODUCT}, please use the
   2 @code{send-pr} program to fill out a Problem Report.
   3
   4 The @code{send-pr} program is installed in the directory
   5 @code{@value{ROOTDIR}/bin}.
   6
   7 @need 1100
   8 Before using @code{send-pr} for the first time, you need to install your
   9 customer support ID into the program, by typing the command:
  10
  11 @smallexample
  12 @b{shell%} install-sid @i{customerID}
  13 @end smallexample
  14
  15 @noindent replacing @i{customerID} with your customer ID, which your
  16 sales representative will supply.
  17
  18 The @code{send-pr} program enters the problem report into our Problem
  19 Report Management System (PRMS), which automatically assigns it to the
  20 engineer best able to help you with problems in the assigned category.
  21 The engineer will work with you via email, telephone, or both, and all
  22 email related to this Problem Report will be tracked by PRMS for future
  23 reference.  If the engineer does not reply to you after a certain time,
  24 a reminder is automatically generated.  If you need to talk to someone
  25 else in our organization about the problem (@i{e.g.}, if the engineer
  26 gets hit by a truck), we can find out what the current state is through
  27 the PR number.  @value{COMPANY} uses PRMS for almost all of the real
  28 problems we handle.
  29
  30 The @code{send-pr} program will try to intelligently fill in as many
  31 fields as it can.  You need to choose the @dfn{category}, @dfn{class},
  32 @dfn{severity}, and @dfn{priority} of the problem, as well as giving us
  33 as much information as you can about its exact nature.
  34
  35 @need 1000
  36 The PR @b{category} will be one of:
  37
  38 @smallexample
  39 @group
  40 kerberos        kerbnet         doc             help-request
  41 info-request    install         query-pr        id-request
  42 send-pr
  43 @end group
  44 @end smallexample
  45
  46 In general, if specific knowledge about Kerberos is requried to answer a
  47 PR, use the @i{kerberos} or @i{doc} categories.  The @i{install}
  48 category is for problems retrieving the code off the media (@i{e.g.},
  49 the data on a tape seems to be corrupted.)  Questions about the
  50 installation procedures described in this document would fall under the
  51 category @i{kerberos}.  The @i{help-request} and @i{info-request}
  52 categories are for general questions about your contract, or other
  53 issues not necessarily related to @value{PRODUCT}.  Use @i{query-pr} to
  54 receive a current copy of your Problem Report, @i{id-request} if you
  55 need a customer ID, and @i{send-pr} if you're having trouble using
  56 send-pr.  If your question is related to @value{PRODUCT} and you're not
  57 sure what the most appropriate category should be, use @i{kerberos}.
  58 The engineer can change the category if necessary.
  59
  60 The @b{class} can be @dfn{sw-bug}, @dfn{doc-bug}, @dfn{change-request},
  61 or @dfn{support}.  The first two are exactly as their names imply.  The
  62 @i{change-request} class is to inform us of changes, such as new email
  63 addresses or new contact information.  The @i{support} class is intended
  64 for general questions about using the @value{PRODUCT} clients or
  65 libraries.
  66
  67 The @b{severity} of the problem indicates the problem's impact on the
  68 usability of the @value{PRODUCT} software package.  If a problem is
  69 @dfn{critical}, that means the product, component or concept is
  70 completely non-operational, or some essential functionality is missing,
  71 and no workaround is known.  A @dfn{serious} problem is one in which the
  72 product, component or concept is not working properly or significant
  73 functionality is missing.  Problems that would otherwise be considered
  74 @i{critical} are rated @i{serious} when a workaround is known.  A
  75 @dfn{non-critical} problem is one that is indeed a problem, but one that
  76 is having a minimal affect on your ability to use @value{PRODUCT}.
  77 @i{E.g.}, The product, component or concept is working in general, but
  78 lacks features, has irritating behavior, does something wrong, or
  79 doesn't match its documentation.  The default severity is @i{serious}.
  80
  81 The @b{priority} indicates how urgent this particular problem is in
  82 relation to your work.  Note that low priority does not imply low
  83 importance.  @value{COMPANY} considers all problems important, and
  84 encourages its customers to be realistic about priority ratings.  A
  85 priority of @dfn{high} means a solution is needed as soon as possible.
  86 A priority of @dfn{medium} means the problem should be solved no later
  87 than the next release.  A priority of @dfn{low} means the problem should
  88 be solved in a future release, but it is not important to your work how
  89 soon this happens.  The default priority is @i{medium}.
  90
  91 Note that a given severity does not necessarily imply a given priority.
  92 For example, a non-critical problem might still have a high priority if
  93 you are faced with a hard deadline.  Conversely, a serious problem might
  94 have a low priority if the feature it is disabling is one that you do
  95 not need.
  96
  97 The @b{release} is as labeled on the software that was shipped.
  98 @i{e.g.}, @code{kerbnet-@value{RELEASE}}.  It is important that you tell
  99 us which release you are using, and whether or not you have made any
 100 private changes.
 101
 102 Bug reports that include proposed fixes are especially welcome.  If you
 103 include proposed fixes, please send them using either context diffs
 104 (@samp{diff -c}) or unified diffs (@samp{diff -u}).
 105
 106 @iftex
 107 @vfill
 108 @end iftex
 109
 110 @page
 111 A sample filled-out form from a company named ``Toasters, Inc.'' might
 112 look like this:
 113
 114 @smallexample
 115 @group
 116 To: bugs@@cygnus.com
 117 Subject: "KDC reply did not match expectations" error
 118 From: joe.smith@@toasters.com
 119 Reply-To: joe.smith@@toasters.com
 120 X-send-pr-version: 3.97-96q1
 121
 122 >Submitter-Id:  toastersinc
 123 >Confidential:  yes
 124 >Originator:    Joe Smith  (+1 415 903 1400)
 125 >Organization:
 126 -----
 127 Joe Smith                       joe.smith@@toasters.com
 128 Toasters, Inc.
 129          ``The best UI in the world''
 130
 131 >Synopsis:      "KDC reply did not match expectations" error message
 132 >Severity:      non-critical
 133 >Priority:      low
 134 >Category:      kerberos
 135 >Class:         sw-bug
 136 >Release:       kerbnet-1.0
 137 >Environment:
 138 NetBSD viola 1.1 NetBSD 1.1 (ATHENAADP) #0: Tue May 21 00:31:42 EDT 1996
 139 i386
 140 System:         Intel P166
 141 Architecture:   NetBSD
 142
 143 >Description:
 144         <description of problem goes here>
 145         Getting "KDC reply did not match expectations" message.  This
 146         does not seem to be affecting anything else.
 147
 148 >How-To-Repeat:
 149         <A code sample is worth a thousand words.>
 150         <If the Problem Report is marked ``Confidential: yes'',>
 151         <it will not be available to anyone but our engineers,>
 152         <please contact us if you are concerned about sensitive source>
 153         <code.>
 154         It happens when I type kinit.
 155
 156 >Fix:
 157         <If you have already found a correct way to stop this problem,>
 158         <please let us know!>
 159         None.  Sorry.
 160 @end group
 161 @end smallexample
 162
 163 @iftex
 164 @vfill
 165 @end iftex
 166
 167 @page
 168 If the @code{send-pr} program does not work for you, you can use the
 169 following template instead:
 170
 171 @smallexample
 172 @group
 173 To: bugs@@cygnus.com
 174 Subject:
 175 From:
 176 Reply-To:
 177 X-send-pr-version: none (typed manually)
 178
 179 >Submitter-Id:
 180 >Originator:
 181 >Organization:
 182         <organization of PR author (multiple lines)>
 183 >Confidential:  <[ yes | no ] (one line)>
 184 >Synopsis:  <synopsis of the problem (one line)>
 185 >Severity:  <[ non-critical | serious | critical ] (one line)>
 186 >Priority:  <[ low | medium | high ] (one line)>
 187 >Category:  <name of the product (one line)>
 188 >Class:     <[ sw-bug | doc-bug | change-request | support ] (one line)>
 189 >Release:      cns-9?q?
 190 >Environment:
 191         <machine, os, target, libraries (multiple lines)>
 192 System:
 193 Architecture:
 194
 195
 196 >Description:
 197     <precise description of the problem (multiple lines)>
 198 >How-To-Repeat:
 199     <code/input/activities to reproduce the problem (multiple lines)>
 200 >Fix:
 201     <how to correct or work around the problem, if known (multiple lines)>
 202 @end group
 203 @end smallexample