pintos-os.org Git - pspp/blob - doc/bugs.texi

   1 @c PSPP - a program for statistical analysis.
   2 @c Copyright (C) 2017 Free Software Foundation, Inc.
   3 @c Permission is granted to copy, distribute and/or modify this document
   4 @c under the terms of the GNU Free Documentation License, Version 1.3
   5 @c or any later version published by the Free Software Foundation;
   6 @c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
   7 @c A copy of the license is included in the section entitled "GNU
   8 @c Free Documentation License".
   9 @c
  10 @node Bugs
  11 @chapter Bugs
  12
  13 @cindex bugs
  14 @cindex troubleshooting
  15
  16 Occasionally you may encounter a bug in @pspp{}.
  17
  18 @section When to report bugs
  19
  20 If you discover a bug, please first:
  21 @itemize @bullet
  22 @item Make sure that it really is a bug.  Sometimes, what may appear
  23 to be a bug, turns out to be a misunderstanding of how to use the program.
  24 If you are unsure, ask for advice on the pspp-users mailing list.
  25 Information about the mailing list is at @uref{http://lists.gnu.org/mailman/listinfo/pspp-users}.
  26 @item Try an up to date version of @pspp{}; the problem
  27  may have been recently fixed.
  28 @item If the problem persists in the up to date version, check to see
  29  if it has already been reported.  Reported issues are listed
  30  at @uref{http://savannah.gnu.org/bugs/?group=pspp}.
  31  For known issues in individual language features, see the relevant section in @pxref{Language}.
  32 @item If the problem exists in a recent version and it has not already
  33  been reported, then please report it.
  34 @end itemize
  35
  36
  37 @section How to report bugs
  38
  39 The best way to send a bug report is using the web page at
  40 @uref{http://savannah.gnu.org/bugs/?group=pspp}.
  41 Alternatively, bug reports may be sent by email
  42 to @email{bug-gnu-pspp@@gnu.org}.
  43
  44 In your bug report please include:
  45 @itemize @bullet
  46 @item The version of @pspp{} in which you encountered the problem.
  47 That means the precise version number.  Do not simply say ``the latest version'' ---
  48 releases happen quickly, and bug reports are archived indefinitely.
  49 @item The operating system and type of computer on which it is running.  On a GNU
  50 or other unix-like system, the output from the @cmd{uname} command is helpful.
  51 @item A sample of the syntax which causes the problem or, if it is a user
  52  interface problem, the sequence of steps required to reproduce it.
  53  Screen shots are not usually helpful unless you are reporting a bug in
  54  the graphical user interface itself.
  55 @item A description of what you think is wrong: What happened that you
  56   didn't expect, and what did you expect to happen?
  57 @end itemize
  58
  59 The following is an example of a useful bug report:
  60 @example
  61 When I run PSPP 0.8.4 on the system:
  62 "Linux knut 3.5.3-gnu #1 PREEMPT Tue Aug 28 10:49:41 UTC 2012 mips64 GNU/Linux"
  63 Executing the following syntax:
  64
  65  DATA LIST FREE /x *.
  66  BEGIN DATA.
  67  1 2 3
  68  END DATA.
  69  LIST.
  70
  71 results in:
  72
  73  4
  74  5
  75  6
  76
  77 I think the output should be:
  78
  79  1
  80  2
  81  3
  82 @end example
  83 @noindent Here, the developers have the necessary information to reproduce the circumstances of the bug report,
  84 and they understand what the reporter expected.
  85
  86
  87 Conversely, the following is a useless bug report:
  88
  89 @example
  90 I downloaded the latest version of PSPP and entered a sequence of numbers,
  91 but when I analyse them it gives the wrong output.
  92 @end example
  93 @noindent In that example, it is impossible to reproduce, and there is no indication
  94 of why the reporter thought what he saw was wrong.
  95
  96 Note that the purpose of bug reports is to help improve the quality of @pspp{}
  97 for the benefit of all users.
  98 It is not a consultancy or support service.  If that is what you want, you are welcome to make
  99 private arrangements.  Since @pspp{} is free software, consultants have access to
 100 the information they need to provide such support.
 101 The @pspp{} developers appreciate all users' feedback, but cannot promise an immediate response.
 102
 103 Please do not use the bug reporting address for general enquiries or to seek
 104 help in using, installing or running the program.
 105 For that, use the pspp-users mailing list mentioned above.
 106