doc/send-pr.texinfo

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