X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fbugs.texi;h=b7dd4a8320b3e21154630ded985d8b5b4303dff2;hb=92c31025565a5b5c270c83b0208ab46a90e9b64b;hp=1df01284df83e86a0424d597843288d73fc35974;hpb=1fc3af93c0ba6cbaf7ef09edc979096b6f16dd6f;p=pspp diff --git a/doc/bugs.texi b/doc/bugs.texi index 1df01284df..b7dd4a8320 100644 --- a/doc/bugs.texi +++ b/doc/bugs.texi @@ -1,85 +1,125 @@ -@node Bugs, Function Index, Not Implemented, Top +@c PSPP - a program for statistical analysis. +@c Copyright (C) 2017 Free Software Foundation, Inc. +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.3 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". +@c +@node Bugs @chapter Bugs -@menu -* Known bugs:: Pointers to other files. -* Contacting the Author:: Where to send the bug reports. -@end menu +@cindex bugs +@cindex troubleshooting -@node Known bugs, Contacting the Author, Bugs, Bugs -@section Known bugs +Occasionally you may encounter a bug in @pspp{}. -This is the list of known bugs in PSPP. In addition, @xref{Not -Implemented}, and @xref{Functions Not Implemented}, for lists of bugs -due to features not implemented. For known bugs in individual language -features, see the documentation for that feature. +If you believe you have found a bug, please +make sure that it really is a bug. Sometimes, what may appear +to be a bug, turns out to be a misunderstanding of how to use the program. +If you are unsure, ask for advice on the pspp-users mailing list. +Information about the mailing list is at @uref{http://lists.gnu.org/mailman/listinfo/pspp-users}. -@itemize @bullet -@item -Nothing has yet been tested exhaustively. Be cautious using PSPP to -make important decisions. - -@item -@code{make check} fails on some systems that don't like the syntax. I'm -not sure why. If someone could make an attempt to track this down, it -would be appreciated. - -@item -PostScript driver bugs: - -@itemize @minus -@item -Does not support driver arguments `max-fonts-simult' or -`optimize-text-size'. +It is also valuable to try the newest version of @pspp{}, since the +problem may have already been fixed. You can always find the newest +version of PSPP by visiting @url{https://www.gnu.org/s/pspp, the PSPP +website}. You might have obtained PSPP from a downstream packager, +such as a GNU/Linux distribution; if your downstream package is not +up-to-date, please ask the distributor to update to the newest +version. -@item -Minor problems with font-encodings. +If the problem persists in the up-to-date version, check to see if it +has already been reported. Reported issues are listed at +@uref{http://savannah.gnu.org/bugs/?group=pspp}. If it has already +been reported, you might consider adding a comment with additional +information or even just to mention that you are also experiencing the +problem, since the PSPP developers are often inclined to work on +issues that are important to a large number of users. -@item -Fails to align fonts along their baselines. + For known issues in individual language features, see the relevant section in @pxref{Language}. -@item -Does not support certain bizarre line intersections--should -never crop up in practice. +If the problem exists in a recent version and it has not already +been reported, then please report it. -@item -Does not gracefully substitute for existing fonts whose -encodings are missing. -@item -Does not perform italic correction or left italic correction -on font changes. +@section How to report bugs -@item -Encapsulated PostScript is unimplemented. -@end itemize - -@item -ASCII driver bugs: +The best way to send a bug report is using the web page at +@uref{http://savannah.gnu.org/bugs/?group=pspp}. +Alternatively, bug reports may be sent by email +to @email{bug-gnu-pspp@@gnu.org}. -@itemize @minus -Does not support `infinite length' or `infinite width' paper. -@end itemize +A high-quality bug report allows the developers to understand, +reproduce, and ultimately fix the problem. We recommend +including the following: +@itemize @bullet +@item The version of @pspp{} in which you encountered the problem +That means the precise version number. ``The latest version'' +is often too ambiguous because +releases happen quickly, and bug reports are archived indefinitely. +@item The operating system and type of computer on which it is running. +@item A sample of the syntax which causes the problem or, if it is a user + interface problem, the sequence of steps required to reproduce it. + Screenshots can be helpful for reporting bugs in the graphical user + interface, especially since GUI bugs can arise on some systems but + not others, but they do not usually help fixing other kinds of bugs. +@item A description of what you think is wrong: What happened that you + didn't expect, and what did you expect to happen? @end itemize -See below for information on reporting bugs not listed here. - -@node Contacting the Author, , Known bugs, Bugs -@section Contacting the Author - -The author can be contacted at e-mail address -@ifinfo -. -@end ifinfo -@iftex -@code{}. -@end iftex - -PSPP bug reports should be sent to -@ifinfo -. -@end ifinfo -@iftex -@code{}. -@end iftex -@setfilename ignored +Here is one example of a bug report that includes all of the elements above: + +@cartouche +@example +When I run PSPP 0.8.4 on my GNU/Linux system, executing the following +syntax: + + DATA LIST FREE /x *. + BEGIN DATA. + 1 2 3 + END DATA. + LIST. + +results in: + + 4 + 5 + 6 + +but I think the output should be: + + 1 + 2 + 3 +@end example +@end cartouche + +The following bug report, on the other hand, does not provide enough +information for PSPP developers to understand the problem. This means +that the developers cannot identify or fix the problem without +additional rounds of questions, which is more work for both the +reporter and the developer: + +@cartouche +@example +I downloaded the latest version of PSPP and entered a sequence of numbers, +but when I analyse them it gives the wrong output. +@end example +@end cartouche + +@pspp{} developers value all users' feedback, but cannot promise +an immediate response. The bug reporting is not a consultancy or +support service, although you can make private arrangements for such +services. Since @pspp{} is free software, consultants have access to +the information they need to provide such support. + +For general enquiries or help, please use the +@uref{http://lists.gnu.org/mailman/listinfo/pspp-users, pspp-users +mailing list} instead of the bug mailing list or bug tracker. + +The PSPP bug tracker and bug reporting mailing list are public. To +privately report a security vulnerability in GNU PSPP, please send +your report to the closed mailing list @email{pspp-security@@gnu.org}. +The PSPP developers will help you assess your report and fix problems +prior to public disclosure.