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 If you believe you have found a bug, please
  19 make sure that it really is a bug.  Sometimes, what may appear
  20 to be a bug, turns out to be a misunderstanding of how to use the program.
  21 If you are unsure, ask for advice on the pspp-users mailing list.
  22 Information about the mailing list is at @uref{http://lists.gnu.org/mailman/listinfo/pspp-users}.
  23
  24 It is also valuable to try the newest version of @pspp{}, since the
  25 problem may have already been fixed.  You can always find the newest
  26 version of PSPP by visiting @url{https://www.gnu.org/s/pspp, the PSPP
  27 website}.  You might have obtained PSPP from a downstream packager,
  28 such as a GNU/Linux distribution; if your downstream package is not
  29 up-to-date, please ask the distributor to update to the newest
  30 version.
  31
  32 If the problem persists in the up-to-date version, check to see if it
  33 has already been reported.  Reported issues are listed at
  34 @uref{http://savannah.gnu.org/bugs/?group=pspp}.  If it has already
  35 been reported, you might consider adding a comment with additional
  36 information or even just to mention that you are also experiencing the
  37 problem, since the PSPP developers are often inclined to work on
  38 issues that are important to a large number of users.
  39
  40  For known issues in individual language features, see the relevant section in @pxref{Language}.
  41
  42 If the problem exists in a recent version and it has not already
  43 been reported, then please report it.
  44
  45
  46 @section How to report bugs
  47
  48 The best way to send a bug report is using the web page at
  49 @uref{http://savannah.gnu.org/bugs/?group=pspp}.
  50 Alternatively, bug reports may be sent by email
  51 to @email{bug-gnu-pspp@@gnu.org}.
  52
  53 A high-quality bug report allows the developers to understand,
  54 reproduce, and ultimately fix the problem.  We recommend
  55 including the following:
  56 @itemize @bullet
  57 @item The version of @pspp{} in which you encountered the problem
  58 That means the precise version number.  ``The latest version''
  59 is often too ambiguous because
  60 releases happen quickly, and bug reports are archived indefinitely.
  61 @item The operating system and type of computer on which it is running.
  62 @item A sample of the syntax which causes the problem or, if it is a user
  63  interface problem, the sequence of steps required to reproduce it.
  64  Screenshots can be helpful for reporting bugs in the graphical user
  65  interface, especially since GUI bugs can arise on some systems but
  66  not others, but they do not usually help fixing other kinds of bugs.
  67 @item A description of what you think is wrong: What happened that you
  68   didn't expect, and what did you expect to happen?
  69 @end itemize
  70
  71 Here is one example of a bug report that includes all of the elements above:
  72
  73 @cartouche
  74 @example
  75 When I run PSPP 0.8.4 on my GNU/Linux system, executing the following
  76 syntax:
  77
  78  DATA LIST FREE /x *.
  79  BEGIN DATA.
  80  1 2 3
  81  END DATA.
  82  LIST.
  83
  84 results in:
  85
  86  4
  87  5
  88  6
  89
  90 but I think the output should be:
  91
  92  1
  93  2
  94  3
  95 @end example
  96 @end cartouche
  97
  98 The following bug report, on the other hand, does not provide enough
  99 information for PSPP developers to understand the problem.  This means
 100 that the developers cannot identify or fix the problem without
 101 additional rounds of questions, which is more work for both the
 102 reporter and the developer:
 103
 104 @cartouche
 105 @example
 106 I downloaded the latest version of PSPP and entered a sequence of numbers,
 107 but when I analyse them it gives the wrong output.
 108 @end example
 109 @end cartouche
 110
 111 @pspp{} developers value all users' feedback, but cannot promise
 112 an immediate response.  The bug reporting is not a consultancy or
 113 support service, although you can make private arrangements for such
 114 services.  Since @pspp{} is free software, consultants have access to
 115 the information they need to provide such support.
 116
 117 For general enquiries or help, please use the
 118 @uref{http://lists.gnu.org/mailman/listinfo/pspp-users, pspp-users
 119 mailing list} instead of the bug mailing list or bug tracker.
 120
 121 The PSPP bug tracker and bug reporting mailing list are public.  To
 122 privately report a security vulnerability in GNU PSPP, please send
 123 your report to the closed mailing list @email{pspp-security@@gnu.org}.
 124 The PSPP developers will help you assess your report and fix problems
 125 prior to public disclosure.