blob: df849d4c166173ffe406feba1c7cde281b175c29 [file] [log] [blame]
Alexandre Julliard638f1691999-01-17 16:32:32 +00001How To Report A Bug
James Juran8d01e081998-11-27 16:06:08 +00002-------------------
3
4Some simple advice on making your bug report more useful (and thus more
5likely to get answered and fixed):
6
71) Post as much information as possible.
8
Alexandre Julliard638f1691999-01-17 16:32:32 +00009 This means we need more information than a simple
10 "MS Word crashes whenever I run it. Do you know why?"
11 Include at least the following information:
James Juran8d01e081998-11-27 16:06:08 +000012
13 - Version of Wine you're using (run 'wine -v')
14 - Operating system you're using, what distribution (if any), and what
Alexandre Julliard638f1691999-01-17 16:32:32 +000015 version
James Juran8d01e081998-11-27 16:06:08 +000016 - Compiler and version (run 'gcc -v')
Alexandre Julliard638f1691999-01-17 16:32:32 +000017 - Windows version, if installed
James Juran8d01e081998-11-27 16:06:08 +000018 - Program you're trying to run, its version number, and a URL for
Alexandre Julliard638f1691999-01-17 16:32:32 +000019 where the program can be obtained (if available)
James Juran8d01e081998-11-27 16:06:08 +000020 - Command line you used to start wine
Alexandre Julliard638f1691999-01-17 16:32:32 +000021 - Any other information you think may be relevant or helpful, such as
22 X server version in case of X problems, libc version etc.
James Juran8d01e081998-11-27 16:06:08 +000023
Alexandre Julliard638f1691999-01-17 16:32:32 +0000242) Re-run the program with the -debugmsg +relay,+snoop option
25 (i.e., 'wine -debugmsg +relay,+snoop sol.exe').
James Juran8d01e081998-11-27 16:06:08 +000026
27 If Wine crashes while running your program, it is important that we
28 have this information to have a chance at figuring out what is causing
29 the crash. This can put out quite a lot (several MB) of information,
30 though, so it's best to output it to a file. When the Wine-dbg> prompt
31 appears, type 'quit'.
32
33 To accomplish this, use the following commands:
34
James Juran38a3d261999-01-01 18:45:52 +000035 tcsh and other csh-like shells:
36
Alexandre Julliard638f1691999-01-17 16:32:32 +000037 wine -debugmsg +relay,+snoop [other_options] program_name |& tee filename.out
James Jurancb5effa1999-01-03 12:28:44 +000038 tail -100 filename.out > report_file
James Juran8d01e081998-11-27 16:06:08 +000039
James Juran38a3d261999-01-01 18:45:52 +000040 bash and other sh-like shells:
41
Alexandre Julliard8da12c41999-01-17 16:55:11 +000042 wine -debugmsg +relay,+snoop [other_options] program_name 2>&1 | tee filename.out
James Jurancb5effa1999-01-03 12:28:44 +000043 tail -100 filename.out > report_file
James Juran38a3d261999-01-01 18:45:52 +000044
James Juran8d01e081998-11-27 16:06:08 +000045 'report_file' will now contain the last hundred lines of the debugging
46 output, including the register dump and backtrace, which are the most
47 important pieces of information. Please do not delete this part, even
48 if you don't understand what it means.
49
503) Post your report to the newsgroup comp.emulators.ms-windows.wine
51
52 In your post, include all of the information from part 1), and insert
53 the text from the output file in part 2). If you do this, your chances
54 of receiving some sort of helpful response should be very good.
55
564) Questions and comments
57
58 If after reading this document there is something you couldn't figure
59 out, or think could be explained better, or that should have been
60 included, please post to comp.emulators.ms-windows.wine to let us know
61 how this document can be improved.