Commit ac3a9a32 authored by Andriy Palamarchuk's avatar Andriy Palamarchuk Committed by Alexandre Julliard

Updated documentation, mostly improving bugs handling. Direct users to

Bugzilla.
parent 3751ff04
For information on how to post a useful bug report, please For information on how to post a useful bug report, please
read documentation/bugreports. read documentation/bugs.sgml.
This is intended to be a place where you should look first if This is intended to be a place where you should look first if
you want to contribute to Wine development. you want to contribute to Wine development.
...@@ -8,7 +8,7 @@ Wine is still alpha software and is very incomplete. ...@@ -8,7 +8,7 @@ Wine is still alpha software and is very incomplete.
If you want to help Wine project you can: If you want to help Wine project you can:
* visit Bugzilla (http://wine.codeweavers.com/bugzilla/) for * visit Bugzilla (http://bugs.winehq.com/) for
list of existing bugs. Metabug 406 lists bugs which are list of existing bugs. Metabug 406 lists bugs which are
reasonably simple to fix even for someone new to Wine. reasonably simple to fix even for someone new to Wine.
Have a look at it and choose subject you are insterested in. Have a look at it and choose subject you are insterested in.
......
...@@ -177,8 +177,6 @@ winedbg correctly according to documentation/debugger.sgml, you will be dropped ...@@ -177,8 +177,6 @@ winedbg correctly according to documentation/debugger.sgml, you will be dropped
into a debugger so that you can investigate and fix the problem. into a debugger so that you can investigate and fix the problem.
For more information on how to do this, please read the file For more information on how to do this, please read the file
documentation/debugging.sgml. documentation/debugging.sgml.
If you post a bug report, please read the file documentation/bugs.sgml to
see what information is required.
You should backup all your important files that you give Wine access You should backup all your important files that you give Wine access
to, or use a special Wine copy of them, as there have been some cases to, or use a special Wine copy of them, as there have been some cases
...@@ -209,17 +207,18 @@ WWW: A great deal of information about Wine is available from WineHQ at ...@@ -209,17 +207,18 @@ WWW: A great deal of information about Wine is available from WineHQ at
FAQ: The Wine FAQ is located at http://www.winehq.com/FAQ FAQ: The Wine FAQ is located at http://www.winehq.com/FAQ
HOWTO: The Wine HOWTO (outdated !) is available at Usenet: You can discuss Wine-related issues and get help
http://www.westfalen.de/witch/wine-HOWTO.txt . on comp.emulators.ms-windows.wine.
Usenet: The best place to get help or to report bugs is the Usenet newsgroup Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.com/.
comp.emulators.ms-windows.wine. Please read the file Please search the bugzilla database to check whether your
documentation/bugs.sgml to see what information should be included problem is already found before posting a bug report. You can
in a bug report. also post bug reports to comp.emulators.ms-windows.wine.
Please read the file documentation/bugs.sgml to see what
information is required.
Please browse old messages on http://groups.google.com/ to check HOWTO: The Wine HOWTO (outdated !) is available at
whether your problem is already fixed before posting a bug report http://www.westfalen.de/witch/wine-HOWTO.txt .
to the newsgroup.
IRC: Online help is available at channel #WineHQ on irc.openprojects.net. IRC: Online help is available at channel #WineHQ on irc.openprojects.net.
...@@ -231,8 +230,8 @@ Mailing lists: ...@@ -231,8 +230,8 @@ Mailing lists:
http://www.winehq.com/dev.shtml#ml for more information. http://www.winehq.com/dev.shtml#ml for more information.
If you add something, or fix a bug, please send a patch (in 'diff -u' If you add something, or fix a bug, please send a patch (in 'diff -u'
format) to julliard@winehq.com or to the wine-patches@winehq.com format) to wine-patches@winehq.com list for inclusion in the next
mailing list for inclusion in the next release. release.
-- --
Alexandre Julliard Alexandre Julliard
......
...@@ -19,6 +19,10 @@ ...@@ -19,6 +19,10 @@
advanced developers. You can also make a bug report the hard advanced developers. You can also make a bug report the hard
way -- advanced developers will probably prefer this. way -- advanced developers will probably prefer this.
</para> </para>
<para>
With using either approach report the found issues with relevant
<ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink>.
</para>
<sect2> <sect2>
<title>The Easy Way</title> <title>The Easy Way</title>
...@@ -49,11 +53,16 @@ ...@@ -49,11 +53,16 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Post a message to the Post the bug to
<systemitem>comp.emulators.ms-windows.wine</systemitem> <ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink>.
newsgroup with the "Nice Formatted Report" attatched. If Please, search Bugzilla database to check whether your problem is
possible, upload the full debug output to a web/ftp already found before posting a bug report.
server and provide the address in your message. Include your own detailed description of the problem with
relevant information. Attach the "Nice Formatted Report"
to the submitted bug. Do not cut and paste the report
in the bug description - it is pretty big.
Keep the full debug output in case it will be needed by
Wine developers.
</para> </para>
</listitem> </listitem>
</orderedlist> </orderedlist>
...@@ -88,7 +97,8 @@ ...@@ -88,7 +97,8 @@
<para>Compiler and version (run <command>gcc -v</command>)</para> <para>Compiler and version (run <command>gcc -v</command>)</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Windows version, if installed</para> <para>Windows version, if used with Wine.
Mention if you don't use Windows</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
...@@ -133,6 +143,9 @@ ...@@ -133,6 +143,9 @@
please use <emphasis>only</emphasis> <parameter>+relay</parameter>!! A bug please use <emphasis>only</emphasis> <parameter>+relay</parameter>!! A bug
report with a crash in <parameter>+snoop</parameter> report with a crash in <parameter>+snoop</parameter>
code is useless in most cases! 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>
<para> <para>
To get the trace output, use the following commands: To get the trace output, use the following commands:
...@@ -182,12 +195,13 @@ ...@@ -182,12 +195,13 @@
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Post your report to the newsgroup Post the bug to
<systemitem>comp.emulators.ms-windows.wine</systemitem> <ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink>.
Please, search Bugzilla database to check whether your problem is
</para> </para>
<para> <para>
In your post, include all of the information from part In your post, include all of the information from part
1), and insert the text from the output file in part 2). 1), and attach to the bug the output file in part 2).
If you do this, your chances of receiving some sort of If you do this, your chances of receiving some sort of
helpful response should be very good. helpful response should be very good.
</para> </para>
...@@ -201,7 +215,7 @@ ...@@ -201,7 +215,7 @@
If after reading this document there is something you If after reading this document there is something you
couldn't figure out, or think could be explained better, or couldn't figure out, or think could be explained better, or
that should have been included, please post to that should have been included, please post to
<systemitem>comp.emulators.ms-windows.wine</systemitem> to <ulink url="http://bugs.winehq.com/">Wine Bugzilla</ulink> to
let us know how this document can be improved. let us know how this document can be improved.
</para> </para>
</sect2> </sect2>
......
...@@ -106,7 +106,7 @@ winspool, wnet, x11 and x11drv. ...@@ -106,7 +106,7 @@ winspool, wnet, x11 and x11drv.
.PP .PP
For more information on debugging messages, see the file For more information on debugging messages, see the file
.I documentation/debug-msgs .I documentation/running.sgml
in the source distribution (FIXME: outdated). in the source distribution (FIXME: outdated).
.RE .RE
.TP .TP
...@@ -313,7 +313,7 @@ Please add entries to this list for applications you currently run. ...@@ -313,7 +313,7 @@ Please add entries to this list for applications you currently run.
Bug reports and successes may be posted to Bug reports and successes may be posted to
.I comp.emulators.ms-windows.wine. .I comp.emulators.ms-windows.wine.
If you want to post a bug report, please read the file If you want to post a bug report, please read the file
.I documentation/bugreports .I documentation/bugs.sgml
in the in the
.B wine .B wine
source to see what information is necessary (FIXME: outdated). source to see what information is necessary (FIXME: outdated).
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment