X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fbugs.texi;h=67b10498bee31192ab70a79b6d35ab928ccc51f1;hb=refs%2Fheads%2Fpivot-table2;hp=1df01284df83e86a0424d597843288d73fc35974;hpb=1fc3af93c0ba6cbaf7ef09edc979096b6f16dd6f;p=pspp diff --git a/doc/bugs.texi b/doc/bugs.texi index 1df01284df..67b10498be 100644 --- a/doc/bugs.texi +++ b/doc/bugs.texi @@ -1,85 +1,97 @@ -@node Bugs, Function Index, Not Implemented, Top +@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. +@section When to report bugs +If you discover a bug, please first: @itemize @bullet -@item -Nothing has yet been tested exhaustively. Be cautious using PSPP to -make important decisions. +@item 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}. +@item Try an up to date version of @pspp{}; the problem + may have been recently fixed. +@item 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}. + For known issues in individual language features, see the relevant section in @pxref{Language}. +@item If the problem exists in a recent version and it has not already + been reported, then please report it. +@end itemize -@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: +@section How to report bugs -@itemize @minus -@item -Does not support driver arguments `max-fonts-simult' or -`optimize-text-size'. +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}. -@item -Minor problems with font-encodings. +In your bug report please include: +@itemize @bullet +@item The version of @pspp{} in which you encountered the problem. +That means the precise version number. Do not simply say ``the latest version'' --- +releases happen quickly, and bug reports are archived indefinitely. +@item The operating system and type of computer on which it is running. On a GNU +or other unix-like system, the output from the @cmd{uname} command is helpful. +@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. + Screen shots are not usually helpful unless you are reporting a bug in + the graphical user interface itself. +@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 -@item -Fails to align fonts along their baselines. +The following is an example of a useful bug report: +@example +When I run PSPP 0.8.4 on the system: +"Linux knut 3.5.3-gnu #1 PREEMPT Tue Aug 28 10:49:41 UTC 2012 mips64 GNU/Linux" +Executing the following syntax: -@item -Does not support certain bizarre line intersections--should -never crop up in practice. + DATA LIST FREE /x *. + BEGIN DATA. + 1 2 3 + END DATA. + LIST. -@item -Does not gracefully substitute for existing fonts whose -encodings are missing. +results in: -@item -Does not perform italic correction or left italic correction -on font changes. + 4 + 5 + 6 -@item -Encapsulated PostScript is unimplemented. -@end itemize +I think the output should be: -@item -ASCII driver bugs: + 1 + 2 + 3 +@end example +@noindent Here, the developers have the necessary information to reproduce the circumstances of the bug report, +and they understand what the reporter expected. -@itemize @minus -Does not support `infinite length' or `infinite width' paper. -@end itemize -@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 +Conversely, the following is a useless bug report: + +@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 +@noindent In that example, it is impossible to reproduce, and there is no indication +of why the reporter thought what he saw was wrong. + +Note that the purpose of bug reports is to help improve the quality of @pspp{} +for the benefit of all users. +It is not a consultancy or support service. If that is what you want, you are welcome to make +private arrangements. Since @pspp{} is free software, consultants have access to +the information they need to provide such support. +The @pspp{} developers appreciate all users' feedback, but cannot promise an immediate response. + +Please do not use the bug reporting address for general enquiries or to seek +help in using, installing or running the program. +For that, use the pspp-users mailing list mentioned above. +