home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / gnats-3.01 / send-pr / send-pr.info < prev    next >
Encoding:
GNU Info File  |  1993-04-14  |  50.2 KB  |  1,351 lines
  1. This is Info file send-pr.info, produced by Makeinfo-1.52 from the
  2. input file send-pr.texi.
  3.  
  4. START-INFO-DIR-ENTRY
  5. * Reporting Problems With send-pr: (send-pr).   Bug Reporting
  6. END-INFO-DIR-ENTRY
  7.  
  8.    Copyright (C) 1993 Free Software Foundation, Inc.
  9.  
  10.    Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice are
  12. preserved on all copies.
  13.  
  14.    Permission is granted to copy and distribute modified versions of
  15. this manual under the conditions for verbatim copying, provided also
  16. that the entire resulting derived work is distributed under the terms
  17. of a permission notice identical to this one.
  18.  
  19.    Permission is granted to copy and distribute translations of this
  20. manual into another language, under the above conditions for modified
  21. versions.
  22.  
  23. 
  24. File: send-pr.info,  Node: Top,  Next: Reporting problems,  Prev: (DIR),  Up: (DIR)
  25.  
  26. Overview
  27. ********
  28.  
  29.    This manual documents `send-pr', which uses electronic mail to
  30. submit support questions and software bugs to a central site.  No piece
  31. of software is perfect, and software organizations understand this;
  32. `send-pr' is designed to allow users who have problems to submit
  33. reports of these problems to sites responsible for supporting the
  34. software in question, in a defined form which can be read by an
  35. electronically managed database.
  36.  
  37.    `send-pr' is part of a suite of programs known collectively as
  38. `GNATS', the GNU Problem Report Management System.  `GNATS' consists of
  39. several programs which, used in concert, formulate and partially
  40. administer a database of Problem Reports, or "PRs", at a central
  41. support site.  A PR goes through several states in its lifetime; `GNATS'
  42. tracks the PR and all information associated with it through each state
  43. and finally acts as an archive for PRs which have been "closed".
  44.  
  45.    Because `send-pr' exists as a shell script and as an `elisp' file
  46. for use within GNU Emacs, it is quite portable.  It can be used from
  47. any machine on your network which can run a shell script and/or Emacs.
  48.  
  49.    Throughout this manual, the personal pronouns "you" and "your" refer
  50. to the originator of the Problem Report.
  51.  
  52.    The `GNATS' utility suite is currently at version 3.00.
  53.  
  54. * Menu:
  55.  
  56. * Reporting problems::    An introduction to `send-pr'
  57. * Invoking send-pr::      Editing and sending PRs
  58. * Installing send-pr::    Installing `send-pr' on your system
  59. * Helpful hints::         Examples and guidelines for effective PRs
  60. * An Example::            A working example
  61. * Index::
  62.  
  63. 
  64. File: send-pr.info,  Node: Reporting problems,  Next: Invoking send-pr,  Prev: Top,  Up: Top
  65.  
  66. An introduction to `send-pr'
  67. ****************************
  68.  
  69.    `GNATS' uses electronic mail to begin processing reported problems
  70. and support requests.  It also automatically forwards the report to
  71. those responsible for the problem in question, and returns mail
  72. acknowledging that the Problem Report ("PR") was received.
  73.  
  74.    All PRs should follow a specific format in order for `GNATS' to
  75. handle them properly.  The easiest way to avoid format problems when
  76. submitting bugs is to use the `send-pr' utility.  `send-pr' invokes an
  77. editor on a default Problem Report template, attempting to
  78. automatically fill in some fields with predefined values.  You then
  79. complete the form with relevant information.  `send-pr' takes over once
  80. you quit the editor, and electronically mails the completed PR using
  81. your local `mail' program.  When a Problem Report is received by `GNATS'
  82. at the support site, its state is considered to be "open".
  83.  
  84.    In general, you can use any editor and mailer to submit valid Problem
  85. Reports, as long as the format required by `GNATS' is preserved.
  86. `send-pr' automates the process, however, and ensures that certain
  87. fields necessary for automatic processing are present.  `send-pr' is
  88. strongly recommended for all initial problem-oriented correspondence
  89. with your support site.  The organization you submit Problem Reports to
  90. will supply an address to which further information can be sent; the
  91. person responsible for the category of the problem you report will
  92. probably contact you direcly.
  93.  
  94. * Menu:
  95.  
  96. * States of Problem Reports::  The Life of a Problem Report
  97. * Problem Report format::      Formatting Problem Reports
  98.  
  99. 
  100. File: send-pr.info,  Node: States of Problem Reports,  Next: Problem Report format,  Up: Reporting problems
  101.  
  102. The Life of a Problem Report
  103. ============================
  104.  
  105.    Each PR goes through a defined series of states between origination
  106. and closure, and is considered "active" until it has been resolved or
  107. otherwise explicitly "closed".  As the originator of a PR, you are
  108. automatically notified of any state changes that occur as long as your
  109. email address in the mail header is correct.
  110.  
  111. "open"
  112.      This is the initial state of a Problem Report.  This means the PR
  113.      has been filed and the responsible person(s) notified.
  114.  
  115. "analyzed"
  116.      The bug has been analyzed by the responsible person.  The analysis
  117.      should contain a preliminary evaluation of the problem and an
  118.      estimate of the amount of time and resources necessary to solve
  119.      the problem.  It should also suggest possible workarounds.
  120.  
  121. "suspended"
  122.      Work on the problem has been postponed.  This happens if a timely
  123.      solution is not possible or is not cost-effective at the present
  124.      time.  The PR continues to exist, though a solution is not being
  125.      actively sought.  If the problem cannot be solved at all, it
  126.      should be closed rather than suspended.
  127.  
  128. "feedback"
  129.      This state indicates that the problem has been solved, and you've
  130.      been given a patch or other fix.  The PR remains in this state
  131.      until you acknowledge that the solution works.
  132.  
  133. "closed"
  134.      A Problem Report is closed only when any changes to the software in
  135.      question have been documented, integrated and tested, and you've
  136.      confirmed the solution.
  137.  
  138. 
  139. File: send-pr.info,  Node: Problem Report format,  Prev: States of Problem Reports,  Up: Reporting problems
  140.  
  141. Problem Report format
  142. =====================
  143.  
  144.    The format of a PR is designed to reflect the nature of `GNATS' as a
  145. database; information is arranged into fields.  A "PR" can be
  146. considered a record that is electronically entered into the `GNATS'
  147. database.  Thus, the level a PR adheres to the standard format
  148. determines the level of interaction that is required by a database
  149. administrator to route the information to the proper place.  (Hint: Keep
  150. in mind that anything that requires human interaction also requires time
  151. that might be better spent in actually fixing the bug.  It is therefore
  152. in the best interest of all parties involved that the information
  153. contained in a PR be as correct as possible at the time of submission.)
  154.  
  155.    The PR form has two main sections, the "mail header" and the
  156. "problem report".  Each has fields that must contain entries before the
  157. PR can be considered complete.
  158.  
  159. * Menu:
  160.  
  161. * Mail Header fields::
  162. * Problem Report fields::
  163.  
  164. 
  165. File: send-pr.info,  Node: Mail Header fields,  Next: Problem Report fields,  Up: Problem Report format
  166.  
  167. Mail Header fields
  168. ------------------
  169.  
  170.    A Problem Report may contain any mail header field described in the
  171. Internet standard RFC-822.  However, only the fields which identify the
  172. sender and the subject are required for `send-pr' to function properly:
  173.  
  174. `To:'
  175.      Automatically supplied by `send-pr'.  It is the preconfigured mail
  176.      address for the support site where the PR is sent.
  177.  
  178. `Subject:'
  179.      Complete this field with a terse description of the problem.
  180.  
  181. `From:'
  182.      Usually supplied automatically by your mailer; should contain your
  183.      electronic mail address.
  184.  
  185. `Reply-To:'
  186.      A return address to which electronic replies can be sent.  In most
  187.      cases, this is probably the same address as the `From:' field.
  188.  
  189. 
  190. File: send-pr.info,  Node: Problem Report fields,  Prev: Mail Header fields,  Up: Problem Report format
  191.  
  192. Problem Report fields
  193. ---------------------
  194.  
  195.    These fields should comprise the only text in the body of the
  196. message in order to avoid confusion.
  197.  
  198.    Problem Report fields begin with a keyword enclosed with `>' and
  199. `:', and belong to one of three data types:
  200.  
  201. ENUMERATED
  202.      One value out of a specific set of choices.  The value must be on
  203.      the same line as the keyword.  For each ENUMERATED keyword, the
  204.      possible choices are listed in the template as a comment.
  205.  
  206. STRING
  207.      One single line of text which must begin and end on the same line
  208.      as the keyword.
  209.  
  210. TEXT
  211.      Text of any length may occur in this field.  TEXT may span multiple
  212.      lines and may also include blank lines.  A TEXT field ends only
  213.      when another keyword appears.
  214.  
  215.    The level of completeness and correctness in the following fields
  216. when the PR is submitted helps determine the speed and quality of the
  217. solution to the problem.
  218.  
  219. `>Submitter-Id:'
  220.      (ENUMERATED) A unique identification code assigned by your support
  221.      site.  It is used to identify all Problem Reports coming from a
  222.      particular site.  (If you don't have an identification code,
  223.      please use `send-pr --request-id' to apply for one from your
  224.      support organization.  Problem Reports from those not affiliated
  225.      with the support organization should use the default value of
  226.      `net' for this field.)
  227.  
  228. `>Originator:'
  229.      (STRING) Your real name.  The default is the value of the
  230.      environment variable `NAME'.
  231.  
  232. `>Organization:'
  233.      (TEXT) The address of your organization.  The default value is the
  234.      contents of the environment variable `ORGANIZATION', or the
  235.      contents of the file `.signature' in your home directory if
  236.      `ORGANIZATION' isn't set.
  237.  
  238. `>Confidential:'
  239.      (ENUMERATED) Use of this field depends on your relationship with
  240.      the support organization; contractual agreements often have
  241.      provisions for preserving confidentiality.  Conversely, a lack of
  242.      a contract often means that any data you provide will not be
  243.      considered confidential.  Contact the support organization
  244.      directly if this is an issue.
  245.  
  246.      If your relationship to the support organization provides for
  247.      confidentiality, then if the value of this field is `yes' the
  248.      support organization treats your PR as confidential; any code
  249.      samples you provide are not made publicly available (e.g., in
  250.      regression test suites).  The default value is `yes'.
  251.  
  252. `>Synopsis:'
  253.      (STRING) One-line summary of the problem.
  254.  
  255. `>Severity:'
  256.      (ENUMERATED) The severity of the problem.  Accepted values are:
  257.  
  258.     `critical'
  259.           The product, component or concept is completely
  260.           non-operational or some essential functionality is missing.
  261.           No workaround is known.
  262.  
  263.     `serious'
  264.           The product, component or concept is not working properly or
  265.           significant functionality is missing.  Problems that would
  266.           otherwise be considered `critical' are rated `serious' when a
  267.           workaround is known.
  268.  
  269.     `non-critical'
  270.           The product, component or concept is working in general, but
  271.           lacks features, has irritating behaviour, does something
  272.           wrong, or doesn't match its documentation.  The default value
  273.      is `serious'.
  274.  
  275. `>Priority:'
  276.      (ENUMERATED) How soon a solution is required.  Accepted values are:
  277.  
  278.     `high'
  279.           A solution is needed as soon as possible.
  280.  
  281.     `medium'
  282.           The problem should be solved in the next release of the
  283.           software.
  284.  
  285.     `low'
  286.           The problem should be solved in a future release.
  287.  
  288.      The default value is `medium'.
  289.  
  290. `>Category:'
  291.      (ENUMERATED) The name of the product, component or concept where
  292.      the problem lies.  Your support organization provides a list of
  293.      valid categories.  Try `send-pr -L' to see the listing provided
  294.      with your distribution.  For an example list, see *Note Valid
  295.      Categories::.
  296.  
  297. `>Class:'
  298.      (ENUMERATED) The class of a problem can be one of the following:
  299.  
  300.     `support'
  301.           A support problem or question.
  302.  
  303.     `sw-bug'
  304.           A software bug.
  305.  
  306.     `doc-bug'
  307.           A bug in the documentation.
  308.  
  309.     `change-request'
  310.           A request for a change in behavior, etc.
  311.  
  312.     `duplicate (PR-NUMBER)'
  313.           Duplicate PR.  PR-NUMBER should be the number of the original
  314.           PR.
  315.  
  316.      The default is `sw-bug'.
  317.  
  318. `>Release:'
  319.      (STRING) Release number or version of the product, component or
  320.      concept.
  321.  
  322. `>Environment:'
  323.      (TEXT) Description of the environment where the problem occured:
  324.      machine architecture, operating system, host and target types,
  325.      libraries, pathnames, etc.
  326.  
  327. `>Description:'
  328.      (TEXT) Precise description of the problem, including all
  329.      preconditions, inputs, outputs, conditions after the problem, and
  330.      symptoms.  Please feel free to provide any additional information
  331.      you think is important.  Include all the details that would be
  332.      necessary for someone else to recreate the problem you're
  333.      submitting, however obvious.  Sometimes seemingly arbitrary or
  334.      obvious information can point the way toward a solution.  *Note
  335.      Helpful hints::, for the types of information to include.
  336.  
  337. `>How-To-Repeat:'
  338.      (TEXT) Example code, input, or activities to reproduce the problem.
  339.      The support organization uses your example code both to reproduce
  340.      the problem and to test whether the problem is fixed.  Again, see
  341.      *Note Helpful hints::, for helpful hints.
  342.  
  343. 
  344. File: send-pr.info,  Node: Invoking send-pr,  Next: Installing send-pr,  Prev: Reporting problems,  Up: Top
  345.  
  346. Editing and sending PRs
  347. ***********************
  348.  
  349.    Invoking `send-pr' presents a partially completed template with a
  350. number of fields already filled in.  Complete the template as fully as
  351. possible to make a useful bug report.  Submit only one bug with each PR.
  352.  
  353.    A template consists of three sections:
  354.  
  355. "Comments"
  356.      The top several lines of a blank template consist of a series of
  357.      comments that provide some basic information about completing the
  358.      Problem Report, as well as a list of valid entries for the
  359.      `>Category:' field.  These comments are all preceded by the string
  360.      `SEND-PR:' and are erased automatically when the PR is submitted.
  361.      Note that the instructional comments within `<' and `>' are also
  362.      removed.  (Only these comments are removed; lines you provide that
  363.      happen to have those characters in them, such as examples of
  364.      shell-level redirection, are not affected.)
  365.  
  366. "Mail Header"
  367.      A standard mail header is provided.  All fields except the
  368.      `Subject:' line are filled with default values.
  369.  
  370. "`send-pr' Fields"
  371.      These are the informational fields that `GNATS' uses to route your
  372.      Problem Report to the responsible party for further action.  They
  373.      should be filled out as completely as possible.
  374.  
  375. An example template and complete Problem Report are provided in *Note
  376. An Example::.
  377.  
  378.    The default template contains your preconfigured `>Submitter-Id:'.
  379. When you invoke `send-pr', it attempts to determine values for the
  380. `>Originator:' and `>Organization:' fields (*note Problem Report
  381. fields::.).  `send-pr' also attempts to find out some information about
  382. your system and architecture, and places this information in the
  383. `>Environment:' field if it finds any.
  384.  
  385.    `send-pr' also provides the mail header section of the template with
  386. default values in the `To:', `From:', and `Reply-To:' fields.  The
  387. `Subject:' field is empty.
  388.  
  389.    Above the main part of the template is a comment section, beginning
  390. with the messages:
  391.  
  392.      SEND-PR: -*- text  -*-
  393.      SEND-PR: Lines starting with `SEND-PR' will be removed
  394.      SEND-PR: automatically as well as all comments (the text
  395.      SEND-PR: below enclosed in `<' and `>').
  396.      SEND-PR:
  397.      SEND-PR: Please consult the document `Reporting Problems
  398.      SEND-PR: With send-pr' if you are not sure how to fill out
  399.      SEND-PR: a problem report.
  400.      SEND-PR:
  401.      SEND-PR: Choose from the following categories:
  402.  
  403. and also containing a list of valid `>Category:' values.  One (and only
  404. one) of these values should be placed in the `>Category:' field.  A
  405. complete sample bug report, from template to completed PR, is shown in
  406. *Note An Example::.  *Note Valid Categories: Valid Categories, for a
  407. sample list of categories, or for a complete list type `send-pr -L' at
  408. your prompt.
  409.  
  410.    The mail header is just below the comment section.  Fill out the
  411. `Subject:' field.  The `To:' field will contain a default value if you
  412. neglected to specify a SITE when invoking `send-pr'.
  413.  
  414.      To: SUPPORT-SITE
  415.      Subject: *complete this field*
  416.      From: YOUR-LOGIN@YOUR-SITE
  417.      Reply-To: YOUR-LOGIN@YOUR-SITE
  418.      X-send-pr-version: send-pr 3.00
  419.  
  420. where SUPPORT-SITE is an alias for the support site you wish to submit
  421. this PR to.
  422.  
  423.    The rest of the template contains `GNATS' fields.  Each field is
  424. either completed with valid information (such as your `>Submitter-Id:')
  425. or contains a one-line instruction specifying the information that
  426. field needs in order to be correct.  For example, the `>Confidential:'
  427. field expects a value of `yes' or `no', and the answer must fit on one
  428. line; similarly, the `>Synopsis:' field expects a short synopsis of the
  429. problem, which must also fit on one line.  Fill out the fields as
  430. completely as possible.
  431.  
  432.      >Submitter-Id:   SUBMITTER-ID
  433.      >Originator:    YOUR NAME HERE
  434.      >Organization:
  435.      YOUR SITE HERE
  436.      >Confidential:<[ yes | no ] (one line)>
  437.      >Synopsis:    <synopsis of the problem (one line)>
  438.      >Severity:    <[ non-critical | serious | critical ] (one line)>
  439.      >Priority:    <[ low | medium | high ] (one line)>
  440.      >Category:    <name of the product (one line)>
  441.      >Class:       <[sw-bug|doc-bug|change-request|support](one line)>
  442.      >Release:     <release number or tag (one line)>
  443.      >Environment:
  444.               <machine, os, target, libraries (multiple lines)>
  445.      
  446.      >Description:
  447.             <precise description of the problem (multiple lines)>
  448.      >How-To-Repeat:
  449.             <code/input/activities to reproduce (multiple lines)>
  450.  
  451.    When you're finished editing the Problem Report, `send-pr' sends the
  452. completed PR to the address named in the `To:' field in the mail
  453. header.  `send-pr' checks that the complete form contains a valid
  454. `>Submitter-Id:' and a valid `>Category:'.  Your copy of `send-pr'
  455. should have already been customized on installation to reflect your
  456. `>Submitter-Id:' (*note Installing `send-pr' on your system: Installing
  457. send-pr.).  If you don't know your `>Submitter-Id:' value, you can
  458. request it using `send-pr --request-id'.  If your organization is not
  459. affiliated with the site you send Problem Reports to, a good generic
  460. `>Submitter-Id:' to use is `net'.
  461.  
  462.    A PR which has a `>Submitter-Id:' equal to `unknown' or which has an
  463. invalid `>Category:' is left in a temporary file named `/tmp/pbadNNNN'
  464. on your machine, where NNNN is replaced by the process id given to your
  465. current `send-pr' session.  An error message is generated specifying
  466. the exact name of the bad file.  You can then edit this file and
  467. resubmit it with
  468.  
  469.      send-pr -f FILENAME
  470.  
  471.    Invoke `send-pr' from a shell prompt or from within GNU Emacs using
  472. `M-x send-pr'.
  473.  
  474. * Menu:
  475.  
  476. * Command line options::    Invoking send-pr from the shell
  477. * send-pr within Emacs::    Using send-pr from within Emacs
  478.  
  479. 
  480. File: send-pr.info,  Node: Command line options,  Next: send-pr within Emacs,  Up: Invoking send-pr
  481.  
  482. Invoking `send-pr' from the shell
  483. =================================
  484.  
  485.      send-pr [ SITE ][ -f PROBLEM-REPORT ] [ -t MAIL-ADDRESS ]
  486.              [ -L ] [ -p ] [ -P ] [ --request-id ] [ -V ]
  487.  
  488.    SITE is an alias on your local machine which points to an address
  489. used by a support site.  If this argument is not present, the default
  490. SITE is usually the site which you received `send-pr' from, or your
  491. local site if you use `GNATS' locally.  (*Note Setting a default SITE:
  492. default site.)
  493.  
  494.    Invoking `send-pr' with no options calls the editor named in your
  495. environment variable `EDITOR'.  If the environment variable `PR_FORM'
  496. is set, its value is used as a file name which contains a valid
  497. template.  If `PR_FORM' contains a missing or unreadable file, or if
  498. the file is empty, `send-pr' generates an error message and opens the
  499. editor on a default template.
  500.  
  501. `-f PROBLEM-REPORT'
  502.      Use this option to specify a file, PROBLEM-REPORT, where a
  503.      completed Problem Report already exists.  `send-pr' sends the
  504.      contents of the file without invoking an editor.  (If
  505.      PROBLEM-REPORT is `-', `send-pr' reads from the standard input;
  506.      `send-pr' uses this feature internally.)
  507.  
  508. `-t MAIL-ADDRESS'
  509.      Sets the electronic mail address to receive the PR.  The default is
  510.      preset when `send-pr' is configured.  This option is not
  511.      recommended; instead, use the argument SITE on the command line.
  512.  
  513. `-L'
  514.      This prints the list of valid `>Category:' values on standard
  515.      output.  No mail is sent.
  516.  
  517. `-p'
  518.      Prints the standard blank template on the standard output.  You can
  519.      print this blank form and use it to generate forms to FAX or
  520.      physically mail to the support site if electronic mail fails to get
  521.      through.  You can also complete some default fields, such as your
  522.      organization's name in the `>Organization:' field, your
  523.      `Submitter-Id:', and details about your machine's architecture in
  524.      the `>Environment:' field, and use it as a custom form.  Specify
  525.      `send-pr' to use this custom form by setting your environment
  526.      variable `PR_FORM' to the name of the customized file.  No mail is
  527.      sent when you use this option.
  528.  
  529. `-P'
  530.      Prints out the template specified by the variable `PR_FORM' in your
  531.      environment.  If `PR_FORM' is not set, the standard blank form is
  532.      printed.  If the file specified by `PR_FORM' doesn't exist, an
  533.      error message is printed.  No mail is sent.
  534.  
  535. `--request-id'
  536.      Specifying this option sends a request for a `>Submitter-Id:' to
  537.      the support site (or to the mail address specified either with the
  538.      `-t' option or in the `To:' field in the mail header).
  539.  
  540. `-V'
  541. `--version'
  542.      Displays the `send-pr' version number and a usage summary.  No mail
  543.      is sent.
  544.  
  545. 
  546. File: send-pr.info,  Node: send-pr within Emacs,  Prev: Command line options,  Up: Invoking send-pr
  547.  
  548. Using `send-pr' from within Emacs
  549. =================================
  550.  
  551.    You can use an interactive `send-pr' interface from within GNU Emacs
  552. to fill out your Problem Report.  We recommend that you familiarize
  553. yourself with Emacs before using this feature (*note Introduction:
  554. (emacs)Introduction.).
  555.  
  556.    The interface is called with `M-x send-pr'.  The interactive
  557. interface prompts you for input for certain fields and then places you
  558. in an Emacs buffer so you can complete the fields specific to your
  559. problem.  It also sets up a few extra key bindings for ease of use.
  560.  
  561.    To start the interactive `send-pr', type
  562.  
  563.      M-x send-pr
  564.  
  565. from inside Emacs.  Emacs responds with a template specifying your
  566. preconfigured template as described above.  You may also submit problem
  567. reports to support sites different from the default site.  To use this
  568. feature, invoke `send-pr' with
  569.  
  570.      C-u SITE M-x send-pr
  571.  
  572.    *Note:* if typing `M-x send-pr' doesn't work, see your system
  573. administrator for help in loading `send-pr' in Emacs.  In short, any
  574. users who wish to use the Emacs version of `send-pr' must place the
  575. following line in their `.emacs' files:
  576.  
  577.      (autoload 'send-pr "send-pr" "Submit a Problem Report." t)
  578.  
  579. For more details on installing `send-pr', see *Note Installing
  580. `send-pr' on your system: Installing send-pr.
  581.  
  582.    If you are using `M-x send-pr', you are prompted in the minibuffer
  583. with the line:
  584.      >Category: other
  585.  
  586. Delete the default value `other' and replace it with the keyword
  587. corresponding to your problem.  For example, if the problem you're
  588. reporting has to do with the GNU C compiler, and your support
  589. organization accepts bugs submitted for this program under the category
  590. `gcc', delete `other' *in the minibuffer* and then type `gcc [RET]'.
  591. Emacs replaces the
  592.      >Category:       <name of the product (one line)>
  593.  
  594. line in the template with
  595.      >Category:       gcc
  596.  
  597. and moves on to another field.
  598.  
  599.    The `M-x send-pr' function provides completion as well; in the above
  600. example you can also type `gc[TAB]', and Emacs will try to complete the
  601. entry for you.  Note that typing `g[TAB]' may not have the same effect
  602. if there are several possible entries beginning with `g'.  In that case
  603. Emacs will not be able to complete the entry because it can not know
  604. whether you meant `gcc' or, say, `gas', if both of those are possible
  605. categories.  `M-x send-pr' continues to prompt you for a valid entry
  606. until you enter one.
  607.  
  608.    `M-x send-pr' prompts you interactively to enter each field for
  609. which there is a range of specific choices.  If you attempt to enter a
  610. value which is not in the range of acceptable entries, Emacs responds
  611. with `[No match]' and allows you to change the entry until it contains
  612. an acceptable value.  This is an excellent way both to avoid unusable
  613. information (at least in these enumerated fields) and also to avoid
  614. typographical errors which could cause problems later.
  615.  
  616.    The interactive mode prompts you for the following fields:
  617.  
  618. `>Category:'
  619. `>Confidential: (DEFAULT=`yes')'
  620. `>Severity: (DEFAULT=`serious')'
  621. `>Priority: (DEFAULT=`medium')'
  622. `>Class: (DEFAULT=`sw-bug')'
  623. `>Release:'
  624.    After you complete these fields, `M-x send-pr' places the cursor in
  625. the `Subject:' line of the mail header and displays the message
  626.      To send the problem report use: C-c C-c
  627.  
  628. in the minibuffer.  At this point, edit the file in the main buffer to
  629. reflect your specific problem, putting relevant information in the
  630. proper fields.  *Note An Example::, for a sample Problem Report.
  631.  
  632.    `M-x send-pr' provides a few key bindings to make it simpler to move
  633. around in a template buffer.
  634.  
  635. `M-p'
  636. `M-x gnats-previous-field'
  637.      moves the cursor to the beginning of the previous field
  638.  
  639. `M-n'
  640. `M-x gnats-next-field'
  641.      moves the cursor to the beginning of the next field
  642.  
  643. `M-C-b'
  644. `M-x gnats-backward-field'
  645.      moves the cursor to the end of the previous field
  646.  
  647. `M-C-f'
  648. `M-x gnats-forward-field'
  649.      moves the cursor to the end of the next field
  650.  
  651.    `send-pr' takes over again when you type `C-c C-c' to send the
  652. message.  Any errors are reported in a separate window.  This window
  653. remains active until you send the PR properly (or, of course, until you
  654. explicitly kill the window).
  655.  
  656.    For detailed instructions for using Emacs, *Note Introduction:
  657. (emacs)Introduction.
  658.  
  659. 
  660. File: send-pr.info,  Node: Installing send-pr,  Next: Helpful hints,  Prev: Invoking send-pr,  Up: Top
  661.  
  662. Installing `send-pr' on your system
  663. ***********************************
  664.  
  665.    If you receive `send-pr' as part of a larger software distribution,
  666. it will most likely be automatically installed when the full
  667. distribution is installed.  If you are using `GNATS' at your site as
  668. well, you must decide where `send-pr' is to send bug reports by
  669. default; see *Note Setting a default SITE: default site.
  670.  
  671. * Menu:
  672.  
  673. * installation::   installing `send-pr' by itself
  674. * default site::   setting a default site
  675.  
  676. 
  677. File: send-pr.info,  Node: installation,  Next: default site,  Up: Installing send-pr
  678.  
  679. Installing `send-pr' by itself
  680. ==============================
  681.  
  682.    The `send-pr' directory, is easily installed by itself by following
  683. these steps (you may need `root' access in order to change the
  684. `aliases' file and to install `send-pr'):
  685.  
  686.   1. *Unpack the distribution* into a directory which we will refer to
  687.      as SRCDIR.
  688.  
  689.   2. *Edit the `Makefile' to reflect local conventions.*
  690.      Specifically, you should edit the variable `prefix' to alter the
  691.      installation location.  The default is `/usr/local'.  All files are
  692.      installed under `prefix' (see below).
  693.  
  694.   3. *Run*
  695.           make all install [ info ] install-info [ clean ]
  696.  
  697.      The targets mean the following:
  698.  
  699.     `all'
  700.           Builds `send-pr' and `install-sid'
  701.  
  702.     `install'
  703.           Installs the following:
  704.  
  705.          `install-sid'
  706.          `send-pr'
  707.                into `PREFIX/bin'
  708.  
  709.          `send-pr.1'
  710.                into `PREFIX/man/man1'
  711.  
  712.          `SITE'
  713.                the list of valid CATEGORIES for the support site you
  714.                received `send-pr' from, installed as
  715.                `PREFIX/lib/gnats/SITE'
  716.  
  717.          `send-pr.el'
  718.                into `PREFIX/lib/emacs/lisp'
  719.  
  720.     `info (*optional*)'
  721.           Builds `send-pr.info' from `send-pr.texi'
  722.           (`send-pr.info' is included with this distribution)
  723.  
  724.     `install-info'
  725.           Installs `send-pr.info' into `PREFIX/info'
  726.  
  727.     `clean (*optional*)'
  728.           Removes all intermediary build files that can be rebuilt from
  729.           source code
  730.  
  731.   4. *Run*
  732.           install-sid YOUR-SID
  733.  
  734.      where YOUR-SID is the identification code you received with
  735.      `send-pr'.  `send-pr' will automatically insert this value into
  736.      the template field `>Submitter-Id'.  If you've downloaded
  737.      `send-pr' from the Net, use `net' for this value.
  738.  
  739.   5. *Any users who wish to use the Emacs version of `send-pr'* must
  740.      place the following line in their `.emacs' files:
  741.  
  742.           (autoload 'send-pr "send-pr" "Submit a Problem Report." t)
  743.  
  744.   6. *Create a mail alias* for the support site you received `send-pr'
  745.      from, and for every site with which you wish to use `send-pr' to
  746.      communicate, each with a suffix of `-gnats'.  The support site(s)
  747.      will provide the correct addresses toward which these aliases
  748.      should point.  For instance, edit your mail aliases file to
  749.      contain something like:
  750.  
  751.           # support sites; for use with send-pr
  752.           cygnus-gnats:     bugs@cygnus.com            # Cygnus Support
  753.           bumblebee-gnats:  bumblebugs@bumblebee.com   # Bumblebee Inc.
  754.           mycompany-gnats:  bugs@my.company.com (*if you use `GNATS' locally*)
  755.  
  756.      `send-pr' automatically searches for these aliases when you type
  757.  
  758.           send-pr cygnus
  759.           send-pr bumblebee
  760.           send-pr SITE...
  761.  
  762.      `send-pr' also uses SITE to determine the categories of bugs the
  763.      site in question accepts by looking in
  764.  
  765.           PREFIX/lib/gnats/SITE
  766.  
  767.  
  768. 
  769. File: send-pr.info,  Node: default site,  Prev: installation,  Up: Installing send-pr
  770.  
  771. Setting a default SITE
  772. ======================
  773.  
  774.    `send-pr' is capable of sending bug reports to any number of support
  775. sites via mail aliases which have `-gnats' appended them.  `send-pr'
  776. automatically appends the suffix, so that when you type
  777.  
  778.      send-pr SITE
  779.  
  780. the bug report will go to the address noted in the `aliases' file as
  781. `SITE-gnats'.  This is done in the Emacs version of `send-pr' by
  782. invoking the program with
  783.  
  784.      C-u SITE M-x send-pr
  785.  
  786. This value is also used to error-check the `>Category:' field, as a
  787. precaution against sending mistaken information (and against sending
  788. information to the wrong site).
  789.  
  790.    You may also simply type
  791.  
  792.      send-pr
  793.  
  794. from the shell (or simply "`M-x send-pr'" in Emacs), and the problem
  795. report you generate will be sent to the "default" site, which is
  796. usually the site from which you received your distribution of
  797. `send-pr'.  If you use `GNATS' at your own organization, the default is
  798. your local bug-reporting address.
  799.  
  800.    To change this, simply edit the file `Makefile' before installing
  801. and change the line
  802.  
  803.      GNATS_SITE = SITE
  804.  
  805. to reflect the site you wish to send PRs to by default.  Again,
  806. `send-pr' automatically appends the `-gnats' to the SITE given on the
  807. command line.
  808.  
  809. 
  810. File: send-pr.info,  Node: Helpful hints,  Next: An Example,  Prev: Installing send-pr,  Up: Top
  811.  
  812. Helpful hints
  813. *************
  814.  
  815.    There is no orthodox standard for submitting effective bug reports,
  816. though you might do well to consult the section on submitting bugs for
  817. GNU `gcc' in *Note Reporting Bugs: (gcc)Bugs, by Richard Stallman, for
  818. information that can typically be useful as well as mistakes to avoid.
  819.  
  820.    In general, common sense (assuming such an animal exists) dictates
  821. the kind of information that would be most helpful in tracking down and
  822. resolving problems in software.
  823.    * Include anything *you* would want to know if you were looking at
  824.      the report from the other end.  There's no need to include every
  825.      minute detail about your environment (users have been known to
  826.      provide the values of every variable in their environments),
  827.      although anything that might be different from someone else's
  828.      environment should be included (your path, for instance).
  829.  
  830.    * Narratives are often useful, given a certain degree of restraint.
  831.      If a person responsible for a bug can see that A was executed, and
  832.      then B and then C, knowing that sequence of events might trigger
  833.      the finding of an intermediate step that was missing, or an extra
  834.      step that might have changed the environment enough to cause a
  835.      visible problem.  Again, restraint is always in order ("I set the
  836.      build running, went to get a cup of coffee (Columbian, cream but
  837.      no sugar), talked to Sheila on the phone, and then THIS
  838.      happened...") but be sure to include anything relevant.
  839.  
  840.    * Richard Stallman writes, "The fundamental principle of reporting
  841.      bugs usefully is this: *report all the facts*.  If you are not sure
  842.      whether to state a fact or leave it out, state it!"  This holds
  843.      true across all problem reporting systems, for computer software
  844.      or social injustice or motorcycle maintenance.  It is especially
  845.      important in the software field due to the major differences
  846.      seemingly insignificant changes can make (a changed variable, a
  847.      missing semicolon).
  848.  
  849.    * Submit only *one* problem with each Problem Report.  If you have
  850.      multiple problems, use multiple PRs.  This aids in tracking each
  851.      problem and also in analyzing the problems associated with a given
  852.      program.
  853.  
  854.    * It never hurts to do a little research to find out if the bug
  855.      you've found has already been reported.  Most software releases
  856.      will have lists of known bugs in the Release Notes which should
  857.      have come with the software; see your system administrator if you
  858.      don't have a copy of these.
  859.  
  860. 
  861. File: send-pr.info,  Node: An Example,  Next: Index,  Prev: Helpful hints,  Up: Top
  862.  
  863. An Example
  864. **********
  865.  
  866.    Cygnus Support in Mountain View, CA, is a heavy user of `GNATS' and
  867. `send-pr'.  As a support company, Cygnus finds problem tracking to be a
  868. crucial part of everyday business.  Cygnus mainly supports the GNU
  869. compiling tools, including `GNATS' and `send-pr', over several Un*x and
  870. Un*x-like platforms, and is an example of `GNATS' in action.
  871.  
  872.    With each shipment of the Cygnus Developer's Toolkit, customers
  873. receive the latest version of `send-pr', which contains an up-to-date
  874. listing of valid categories (values for the `>Category:' field).  Using
  875. these tools, Cygnus' customers can communicate their problems to Cygnus
  876. effectively and receive automatic confirmation of receipt as well as
  877. notification of changes in the status of their reported problems.  Much
  878. of Cygnus' support mechanism relies on electronic mail.
  879.  
  880.    As an example, let's pretend we're a customer of Cygnus Support, and
  881. that we're having a problem with some of our software.
  882.  
  883.    Assume that we're getting an error in our bifrabulator program
  884. wherein the prestidigitation routines don't match with the
  885. whatsitsname.  We've made sure we're following the rules of the program
  886. and checked the Release Notes from Cygnus and found that the bug isn't
  887. already known.  In other words, we're pretty sure we've found a bug.
  888.  
  889.    Our first step is to call `send-pr'.  It really doesn't matter
  890. whether we use `send-pr' from the shell or from within Emacs.  Indeed,
  891. if we use Emacs as a primary editor, calling `send-pr' from the shell
  892. is likely to start `send-pr' in an Emacs buffer anyway.  So, since our
  893. company, *Imaginary Software, Ltd.*, is a heavy user of GNU software,
  894. we're pretty familiar with Emacs, so from within Emacs we type
  895.      M-x send-pr
  896.  
  897. and we're greeted with the following screen:
  898.  
  899.      SEND-PR: -*- text  -*-
  900.      SEND-PR: Lines starting with `SEND-PR' will be removed
  901.      SEND-PR: automatically as well as all comments (the text
  902.      SEND-PR: below enclosed in `<' and `>').
  903.      SEND-PR: Please consult the manual if you are not sure
  904.      SEND-PR: how to fill out a problem report.
  905.      SEND-PR:
  906.      SEND-PR: Choose from the following categories:
  907.      SEND-PR:
  908.      SEND-PR:           bfd       binutils  bison
  909.      SEND-PR: byacc     clib      config    cvs         diff
  910.      SEND-PR: doc       emacs     flex      g++         gas
  911.      SEND-PR: gcc       gdb       glob      gprof       grep
  912.      SEND-PR: info      ispell    kerberos  ld          libg++
  913.      SEND-PR: libiberty make      makeinfo  mas         newlib
  914.      SEND-PR: other     patch     rcs       readline    send-pr
  915.      SEND-PR: test      texindex  texinfo   texinfo.tex
  916.      SEND-PR: bifrabulator  <---*note: this one is fake*
  917.      SEND-PR:
  918.      To: cygnus-bugs@cygnus.com
  919.      Subject:
  920.      From: jeffrey@imaginary.com
  921.      Reply-To: jeffrey@imaginary.com
  922.      X-send-pr-version: send-pr 3.00
  923.      
  924.      >Submitter-Id:  imaginary
  925.      >Originator:    Jeffrey Osier
  926.      >Organization:
  927.      Imaginary Software, Ltd.
  928.      >Confidential:  <[ yes | no ] (one line)>
  929.      >Synopsis:      <synopsis of the problem (one line)>
  930.      >Severity:      <[ non-critical | serious | critical ] (one line)>
  931.      >Priority:      <[ low | medium | high ] (one line)>
  932.      >Category:      <name of the product (one line)>
  933.      >Class:         <[sw-bug|doc-bug|change-request|support](oneline)>
  934.      >Release:       <release number or tag (one line)>
  935.      >Environment:
  936.               <machine, os, target, libraries (multiple lines)>
  937.      System: SunOS imaginary.com 4.1.1 1 sun4
  938.      Architecture: sun4
  939.      
  940.      >Description:
  941.             <precise description of the problem (multiple lines)>
  942.      >How-To-Repeat:
  943.             <code/input/activities to reproduce (multiple lines)>
  944.      
  945.      -----Emacs: *send-pr*   (send-pr Fill)----All------------------
  946.      >Category: other[]
  947.  
  948.    We know from past experience that we need to set certain information
  949. into each field, so we compile all the information we know about our
  950. problem.  We have some sample code which we know should work, even
  951. though it doesn't, so we'll include that.  Below is the completed PR;
  952. we send this using `C-c C-c'.  (The comments have been truncated).
  953.  
  954.      SEND-PR: Lines starting with `SEND-PR' will be removed
  955.      SEND-PR: automatically as well as all comments (the text
  956.      SEND-PR: ...
  957.      SEND-PR:
  958.      To: cygnus-bugs@cygnus.com
  959.      Subject: bifrabulator routines don't match
  960.      From: jeffrey@imaginary.com
  961.      Reply-To: jeffrey@imaginary.com
  962.      X-send-pr-version: send-pr 3.00
  963.      
  964.      >Submitter-Id:  imaginary
  965.      >Originator:    Jeffrey Osier
  966.      >Organization:
  967.      Imaginary Software, Ltd.
  968.      >Confidential:  no
  969.      >Synopsis:      bifrabulator routines don't match
  970.      >Severity:      serious
  971.      >Priority:      medium
  972.      >Category:      bifrabulator
  973.      >Class:         sw-bug
  974.      >Release:       progressive-930101
  975.      >Environment:
  976.      System: SunOS imaginary.com 4.1.1 1 sun4
  977.      Architecture: sun4 (SPARC)
  978.      
  979.      >Description:
  980.         the following code I fed into the bifrabulator came back
  981.         with a strange error.  apparently, the prestidigitation
  982.         routine doesn't match with the whatsitsname in all cases.
  983.      
  984.      >How-To-Repeat:
  985.         call the bifrabulator on the following code.
  986.         CODE SAMPLE...
  987.      
  988.      
  989.      -----Emacs: *send-pr*   (send-pr Fill)----All------------------
  990.      To send the problem report use: C-c C-c
  991.  
  992.    We type `C-c C-c', and off it goes.  Now, we depend on Cygnus
  993. Support to figure out the answer to our problem.
  994.  
  995.    Soon afterward, we get the following message from Cygnus:
  996.  
  997.      From: gnats (GNATS management)
  998.      Sender: gnats-admin
  999.      Reply-To: hacker@cygnus.com
  1000.      To: jeffrey@imaginary.com
  1001.      Subject: Re: bifrabulator/1425: routines don't match
  1002.      
  1003.      Thank you very much for your problem report.
  1004.      It has the internal identification: g++/1425.
  1005.      The individual assigned to look at your bug is:  hacker
  1006.      (F.B. Hacker)
  1007.      
  1008.      Category: bifrabulator
  1009.      Responsible: hacker
  1010.      Synopsis: bifrabulator routines don't match
  1011.      Arrival-Date: Sat Feb 30 03:12:55 1993
  1012.  
  1013. This is our "receipt" that the bug has been accepted and forwarded to
  1014. the responsible party.
  1015.  
  1016. A while later, we get the analysis:
  1017.  
  1018.      To:  jeffrey@imaginary.com
  1019.      From:  hacker@cygnus.com
  1020.      Subject:  Re: bifrabulator/1425: routines don't match
  1021.      Reply-To: hacker@cygnus.com
  1022.      
  1023.      Got your message, Jeff.  It seems that the bifrabulator was
  1024.      confusing the prestidigitation routines with the realitychecker
  1025.      when lexically parsing the whatsitsname.
  1026.      
  1027.      I'm working on robustisizing the bifrabulator now.
  1028.      
  1029.      How about lunch next week?
  1030.      --
  1031.      F.B. Hacker
  1032.      Cygnus Support, Mountain View, CA  415 903 1400
  1033.      #include <std-disclaimer.h>
  1034.  
  1035. About the same time, we get another message from Cygnus.
  1036.  
  1037.      From: hacker@cygnus.com
  1038.      To:  jeffrey@imaginary.com
  1039.      Subject:  Re: bifrabulator/1425: doesn't match prestidig
  1040.      Reply-To:  hacker@cygnus.com
  1041.      
  1042.      
  1043.                   `F.B. Hacker' changed the state to `analyzed'.
  1044.      
  1045.      State-Changed-From-To: open-analyzed
  1046.      State-Changed-By: hacker
  1047.      State-Changed-When: Fri Feb 31 1993 08:59:16 1993
  1048.      State-Changed-Why:
  1049.          figured out the problem, working on a patch this afternoon
  1050.      --
  1051.      F.B. Hacker
  1052.      Cygnus Support, Mountain View, CA  415 903 1400
  1053.      #include <std-disclaimer.h>
  1054.  
  1055. The bug has now been analyzed, and Cygnus is working on a solution.
  1056. Sometime later, we get more mail from F.B.:
  1057.  
  1058.      To:  jeffrey@imaginary.com
  1059.      From:  hacker@cygnus.com
  1060.      Subject:  Re: bifrabulator/1425: routines don't match
  1061.      Reply-To: hacker@cygnus.com
  1062.      
  1063.      There's a patch now that you can ftp over and check out.
  1064.      
  1065.      Hey, that joke you sent me was great!  The one about the
  1066.      strings walking into a bar...  my boss laughed for an hour!
  1067.      --
  1068.      F.B. Hacker
  1069.      Cygnus Support, Mountain View, CA  415 903 1400
  1070.      #include <std-disclaimer.h>
  1071.  
  1072.      From: hacker@cygnus.com
  1073.      To:  jeffrey@imaginary.com
  1074.      Subject:  Re: bifrabulator/1425: doesn't match prestidig
  1075.      Reply-To:  hacker@cygnus.com
  1076.      
  1077.      
  1078.                   `F.B. Hacker' changed the state to `feedback'.
  1079.      
  1080.      State-Changed-From-To: analyzed-feedback
  1081.      State-Changed-By: hacker
  1082.      State-Changed-When: Fri Feb 31 1993 23:43:16 1993
  1083.      State-Changed-Why:
  1084.          got the patch finished, notified Jeff at Imaginary Software
  1085.      --
  1086.      F.B. Hacker
  1087.      Cygnus Support, Mountain View, CA  415 903 1400
  1088.      #include <std-disclaimer.h>
  1089.  
  1090. The bug has gone into "feedback" status now, until we get the patch,
  1091. install it and test it.  When everything tests well, we can mail F.B.
  1092. back and tell him the bug's been fixed, and he can change the state of
  1093. the PR from "feedback" to "closed".
  1094.  
  1095.    Following is a list of valid `>Category:' entries that are supported
  1096. by Cygnus.
  1097.  
  1098. * Menu:
  1099.  
  1100. * Valid Categories::    A listing of Cygnus' valid categories
  1101.  
  1102. 
  1103. File: send-pr.info,  Node: Valid Categories,  Up: An Example
  1104.  
  1105. Valid Categories
  1106. ================
  1107.  
  1108. `bfd'
  1109.      GNU binary file descriptor library.
  1110.  
  1111. `bifrabulator'
  1112.      This one doesn't actually exist.
  1113.  
  1114. `binutils'
  1115.      GNU utilities for binary files (`ar', `nm', `size'...).
  1116.  
  1117. `bison'
  1118.      GNU parser generator.
  1119.  
  1120. `byacc'
  1121.      Free parser generator.
  1122.  
  1123. `config'
  1124.      Cygnus Support Software configuration and installation.
  1125.  
  1126. `cvs'
  1127.      Concurrent Version System.
  1128.  
  1129. `diff'
  1130.      GNU `diff' program.
  1131.  
  1132. `doc'
  1133.      Documentation and manuals.
  1134.  
  1135. `emacs'
  1136.      GNU Emacs editor and related functions.
  1137.  
  1138. `flex'
  1139.      GNU lexical analyzer.
  1140.  
  1141. `g++'
  1142.      GNU C++ compiler.
  1143.  
  1144. `gas'
  1145.      GNU assembler.
  1146.  
  1147. `gcc'
  1148.      GNU C compiler.
  1149.  
  1150. `gdb'
  1151.      GNU source code debugger.
  1152.  
  1153. `glob'
  1154.      The filename globbing functions.
  1155.  
  1156. `gprof'
  1157.      GNU profiler.
  1158.  
  1159. `grep'
  1160.      GNU `grep' program.
  1161.  
  1162. `info'
  1163.      GNU `info' hypertext reader.
  1164.  
  1165. `ispell'
  1166.      GNU spelling checker.
  1167.  
  1168. `kerberos'
  1169.      Kerberos authentication system.
  1170.  
  1171. `ld'
  1172.      GNU linker.
  1173.  
  1174. `libc'
  1175.      Cygnus Support C Support Library.
  1176.  
  1177. `libg++'
  1178.      GNU C++ class library.
  1179.  
  1180. `libiberty'
  1181.      GNU `libiberty' library.
  1182.  
  1183. `libm'
  1184.      Cygnus Support C Math Library.
  1185.  
  1186. `make'
  1187.      GNU `make' program.
  1188.  
  1189. `makeinfo'
  1190.      GNU utility to build Info files from Texinfo documents.
  1191.  
  1192. `mas'
  1193.      GNU Motorola syntax assembler.
  1194.  
  1195. `newlib'
  1196.      Cygnus Support C Support and Math Libraries.
  1197.  
  1198. `patch'
  1199.      GNU bug patch program.
  1200.  
  1201. `gnats'
  1202.      GNU Problem Report Management System.
  1203.  
  1204. `rcs'
  1205.      Revision Control System.
  1206.  
  1207. `readline'
  1208.      GNU `readline' library.
  1209.  
  1210. `send-pr'
  1211.      GNU Problem Report submitting program.
  1212.  
  1213. `test'
  1214.      Category to use when testing `send-pr'.
  1215.  
  1216. `texindex'
  1217.      GNU documentation indexing utility.
  1218.  
  1219. `texinfo'
  1220.      GNU documentation macros.
  1221.  
  1222. `other'
  1223.      Anything which is not covered by the above categories.
  1224.  
  1225. 
  1226. File: send-pr.info,  Node: Index,  Prev: An Example,  Up: Top
  1227.  
  1228. Index
  1229. *****
  1230.  
  1231. * Menu:
  1232.  
  1233. * send-pr fields:                       Invoking send-pr.
  1234. * send-pr within Emacs:                 send-pr within Emacs.
  1235. * *analyzed* state:                     States of Problem Reports.
  1236. * *closed* state:                       States of Problem Reports.
  1237. * *feedback* state:                     States of Problem Reports.
  1238. * *open* bugs:                          States of Problem Reports.
  1239. * *suspended* state:                    States of Problem Reports.
  1240. * -request-id option:                   Problem Report fields.
  1241. * -request-id option:                   Invoking send-pr.
  1242. * -request-id option:                   Command line options.
  1243. * -f PROBLEM-REPORT option:             Command line options.
  1244. * -L option:                            Command line options.
  1245. * -p option:                            Command line options.
  1246. * -P option:                            Command line options.
  1247. * -t MAIL-ADDRESS option:               Command line options.
  1248. * -V option:                            Command line options.
  1249. * Category field:                       Problem Report fields.
  1250. * Class field:                          Problem Report fields.
  1251. * Confidential field:                   Problem Report fields.
  1252. * Description field:                    Problem Report fields.
  1253. * Environment field:                    Problem Report fields.
  1254. * How-To-Repeat field:                  Problem Report fields.
  1255. * Organization field:                   Problem Report fields.
  1256. * Originator field:                     Problem Report fields.
  1257. * Priority field:                       Problem Report fields.
  1258. * Release field:                        Problem Report fields.
  1259. * Severity field:                       Problem Report fields.
  1260. * Submitter-Id:                         Invoking send-pr.
  1261. * Submitter-Id field:                   Problem Report fields.
  1262. * Synopsis field:                       Problem Report fields.
  1263. * GNU software support:                 An Example.
  1264. * addresses:                            Reporting problems.
  1265. * an example:                           An Example.
  1266. * automatic notification:               States of Problem Reports.
  1267. * bad Problem Reports:                  Invoking send-pr.
  1268. * command line options:                 Command line options.
  1269. * comment section:                      Invoking send-pr.
  1270. * completed Problem Report:             An Example.
  1271. * completion in Emacs:                  send-pr within Emacs.
  1272. * Cygnus Support:                       An Example.
  1273. * database similarities:                Problem Report format.
  1274. * default PR template:                  An Example.
  1275. * editing and sending PRs:              Invoking send-pr.
  1276. * effective problem reporting:          Helpful hints.
  1277. * Emacs:                                send-pr within Emacs.
  1278. * email addresses:                      Reporting problems.
  1279. * errors:                               Invoking send-pr.
  1280. * example of a completed PR:            An Example.
  1281. * example of a default template:        An Example.
  1282. * example of a list of valid categories: Valid Categories.
  1283. * example of a state change:            An Example.
  1284. * example PR:                           An Example.
  1285. * fields:                               Problem Report format.
  1286. * final state ("closed"):               States of Problem Reports.
  1287. * foreword to send-pr:                  Top.
  1288. * format:                               Problem Report format.
  1289. * helpful hints:                        Helpful hints.
  1290. * Imaginary Software, Ltd.:             An Example.
  1291. * information to submit:                Helpful hints.
  1292. * initial state ("open"):               States of Problem Reports.
  1293. * installation:                         Installing send-pr.
  1294. * interactive interface:                send-pr within Emacs.
  1295. * Internet standard RFC-822:            Mail Header fields.
  1296. * introduction:                         Reporting problems.
  1297. * introduction to send-pr:              Top.
  1298. * invalid Problem Reports:              Invoking send-pr.
  1299. * invoking send-pr from Emacs:          send-pr within Emacs.
  1300. * invoking send-pr from the shell:      Command line options.
  1301. * invoking send-pr:                     Invoking send-pr.
  1302. * kinds of helpful information:         Helpful hints.
  1303. * life-cycle of a Problem Report:       States of Problem Reports.
  1304. * Listing valid categories:             Command line options.
  1305. * mail header fields:                   Mail Header fields.
  1306. * mail header section:                  Invoking send-pr.
  1307. * overview to send-pr:                  Top.
  1308. * Problem Report data types:            Problem Report fields.
  1309. * Problem Report fields:                Problem Report fields.
  1310. * Problem Report fields - list:         Problem Report fields.
  1311. * Problem Report format:                Problem Report format.
  1312. * Problem Report states:                States of Problem Reports.
  1313. * Report all the facts!:                Helpful hints.
  1314. * reporting problems:                   Reporting problems.
  1315. * sending PRs:                          Invoking send-pr.
  1316. * shell invocation:                     Command line options.
  1317. * state change example:                 An Example.
  1318. * state--"analyzed":                    States of Problem Reports.
  1319. * state--"closed":                      States of Problem Reports.
  1320. * state--"feedback":                    States of Problem Reports.
  1321. * state--"open":                        States of Problem Reports.
  1322. * state--"suspended":                   States of Problem Reports.
  1323. * states of Problem Reports:            States of Problem Reports.
  1324. * template:                             Invoking send-pr.
  1325. * Using and Porting GNU CC:             Helpful hints.
  1326. * using send-pr:                        Invoking send-pr.
  1327. * valid categories:                     Valid Categories.
  1328. * version 3.00:                         Top.
  1329.  
  1330.  
  1331. 
  1332. Tag Table:
  1333. Node: Top821
  1334. Node: Reporting problems2520
  1335. Node: States of Problem Reports4251
  1336. Node: Problem Report format5889
  1337. Node: Mail Header fields6959
  1338. Node: Problem Report fields7798
  1339. Node: Invoking send-pr13427
  1340. Node: Command line options19320
  1341. Node: send-pr within Emacs22190
  1342. Node: Installing send-pr26589
  1343. Node: installation27192
  1344. Node: default site30210
  1345. Node: Helpful hints31525
  1346. Node: An Example34184
  1347. Node: Valid Categories43273
  1348. Node: Index45091
  1349. 
  1350. End Tag Table
  1351.