Module: docs Branch: master Commit: 7f3036f44325b24ce40c55afafacfdbc7a760274 URL: http://source.winehq.org/git/docs.git/?a=commit;h=7f3036f44325b24ce40c55afaf...
Author: Jeff Zaroyko jeffz@jeffz.name Date: Thu Jul 15 16:21:41 2010 +1000
wineusr: Update bug reporting information.
---
en/wineusr-bugs.sgml | 138 ++++++++++---------------------------------------- 1 files changed, 27 insertions(+), 111 deletions(-)
diff --git a/en/wineusr-bugs.sgml b/en/wineusr-bugs.sgml index 7a54512..06b48be 100644 --- a/en/wineusr-bugs.sgml +++ b/en/wineusr-bugs.sgml @@ -265,6 +265,28 @@ </listitem> <listitem> <para> + If there is a crash dialog on the screen acknowledge it so ensure + all information is printed to the terminal. + </para> + </listitem> + <listitem> + <para> + Useful terminal output + contains a backtrace with debug symbols, see the + <ulink url="http://wiki.winehq.org/Backtraces">Backtraces wiki entry</ulink> + </para> + </listitem> + <listitem> + <para> + Create an attachment with full terminal output in a text file. + <literallayout> + <command>cd ~/.wine/drive_c/Games/Tron</command> + <command>wine tron.exe &> log.txt</command> + </literallayout> + </para> + </listitem> + <listitem> + <para> The exact steps required to reproduce the bug. </para> </listitem> @@ -279,13 +301,13 @@ </listitem> <listitem> <para> - Re-run the program with the WINEDEBUG environment variable <parameter> - WINEDEBUG=+relay</parameter> option (i.e., <command>WINEDEBUG=+relay - wine sol.exe</command>). + You may be asked to re-run the program with the WINEDEBUG environment variable <parameter> + WINEDEBUG=+relay,+seh,+tid</parameter> option (i.e., <command>WINEDEBUG=+relay,+seh,+tid + wine sol.exe &> log.txt</command>). </para> <para> - This will output additional information at the console - that may be helpful in debugging the program. It also + This will produce additional information which may include the cause + for a crash or may be helpful in debugging the program. It also slows the execution of program. There are some cases where the bug seems to disappear when <parameter> +relay </parameter> is used. Please mention that in the bug report. @@ -293,112 +315,6 @@ </listitem> </orderedlist> </sect2> - <sect2> - <title>Crashes</title> - <para> - If Wine crashes while running your program, it is - important that we have this information to have a chance - at figuring out what is causing the crash. This can put - out quite a lot (several MB) of information, though, so - it's best to output it to a file. When the <prompt>Wine-dbg></prompt> - prompt appears, type <userinput>quit</userinput>. - </para> - <para> - You might want to try - <parameter>+relay,+snoop</parameter> instead of - <parameter>+relay</parameter>, but please note that - <parameter>+snoop</parameter> is pretty unstable and - often will crash earlier than a simple - <parameter>+relay</parameter>! If this is the case, then - please use <emphasis>only</emphasis> <parameter>+relay</parameter>!! - A bug report with a crash in <parameter>+snoop</parameter> - code is useless in most cases! - You can also turn on other parameters, depending on the nature - of the problem you are researching. See wine man page for full list - of the parameters. - </para> - <para> - It is likely that only the last 100 or so lines of the - trace are necessary to find out where the program crashes. - In order to get those last 100 lines we need to do the following - </para> - <orderedlist> - <listitem> - <para> - Redirect all the output of <parameter> WINEDEBUG </parameter> - to a file. - </para> - </listitem> - <listitem> - <para> - Separate the last 100 lines to another file using - <command>tail</command>. - </para> - </listitem> - </orderedlist> - <para> - This can be done using one of the following methods. - </para> - <variablelist> - <varlistentry> - <term>all shells:</term> - <listitem> - <screen> -<prompt>$ </prompt>echo quit | WINEDEBUG=+relay wine [other_options] program_name >& filename.out; -<prompt>$ </prompt>tail -n 100 filename.out > report_file - </screen> - <para> - (This will print wine's debug messages only to the file - and then auto-quit. It's probably a good idea to use this - command, since wine prints out so many debug msgs that - they flood the terminal, eating CPU cycles.) - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>tcsh and other csh-like shells:</term> - <listitem> - <screen> -<prompt>$ </prompt>WINEDEBUG=+relay wine [other_options] program_name |& tee filename.out; -<prompt>$ </prompt>tail -n 100 filename.out > report_file - </screen> - </listitem> - </varlistentry> - <varlistentry> - <term>bash and other sh-like shells:</term> - <listitem> - <screen> -<prompt>$ </prompt>WINEDEBUG=+relay wine [other_options] program_name 2>&1 | tee filename.out; -<prompt>$ </prompt>tail -n 100 filename.out > report_file - </screen> - </listitem> - </varlistentry> - </variablelist> - <para> - <filename>report_file</filename> will now contain the - last hundred lines of the debugging output, including - the register dump and backtrace, which are the most - important pieces of information. Please do not delete - this part, even if you don't understand what it means. - </para> - <para> - Post the bug to - <ulink url="http://bugs.winehq.org/">Wine Bugzilla</ulink>. - You need to attach the output file <filename>report_file</filename> - from part 2). Along with the the relevant information - used to create it. Do not cut and paste the report - in the bug description - it is pretty big and it will - make a mess of the bug report. - If you do this, your chances of receiving some sort of - helpful response should be very good. - </para> - <para> - Please, search the Bugzilla database to check whether your problem - is already reported. If it is already reported attach the - output file <filename>report_file</filename> to the original - bug report and add any other relevant information. - </para> - </sect2> </sect1> </chapter>