From ac3a9a327a449ef899507e02be11775505eb12cc Mon Sep 17 00:00:00 2001 From: Andriy Palamarchuk Date: Sat, 4 May 2002 18:41:27 +0000 Subject: [PATCH] Updated documentation, mostly improving bugs handling. Direct users to Bugzilla. --- BUGS | 4 ++-- README | 25 ++++++++++++------------- documentation/bugs.sgml | 34 ++++++++++++++++++++++++---------- documentation/wine.man.in | 4 ++-- 4 files changed, 40 insertions(+), 27 deletions(-) diff --git a/BUGS b/BUGS index 72b5302b6f6..52a011539e0 100644 --- a/BUGS +++ b/BUGS @@ -1,5 +1,5 @@ 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 you want to contribute to Wine development. @@ -8,7 +8,7 @@ Wine is still alpha software and is very incomplete. 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 reasonably simple to fix even for someone new to Wine. Have a look at it and choose subject you are insterested in. diff --git a/README b/README index 72d957341e1..623dc80f36c 100644 --- a/README +++ b/README @@ -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. For more information on how to do this, please read the file 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 to, or use a special Wine copy of them, as there have been some cases @@ -209,18 +207,19 @@ 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 +Usenet: You can discuss Wine-related issues and get help + on comp.emulators.ms-windows.wine. + +Bugs: Report bugs to Wine Bugzilla at http://bugs.winehq.com/. + Please search the bugzilla database to check whether your + problem is already found before posting a bug report. You can + also post bug reports to comp.emulators.ms-windows.wine. + Please read the file documentation/bugs.sgml to see what + information is required. + HOWTO: The Wine HOWTO (outdated !) is available at http://www.westfalen.de/witch/wine-HOWTO.txt . -Usenet: The best place to get help or to report bugs is the Usenet newsgroup - comp.emulators.ms-windows.wine. Please read the file - documentation/bugs.sgml to see what information should be included - in a bug report. - - Please browse old messages on http://groups.google.com/ to check - whether your problem is already fixed before posting a bug report - to the newsgroup. - IRC: Online help is available at channel #WineHQ on irc.openprojects.net. CVS: The current Wine development tree is available through CVS. @@ -231,8 +230,8 @@ Mailing lists: 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' -format) to julliard@winehq.com or to the wine-patches@winehq.com -mailing list for inclusion in the next release. +format) to wine-patches@winehq.com list for inclusion in the next +release. -- Alexandre Julliard diff --git a/documentation/bugs.sgml b/documentation/bugs.sgml index dcc6bf722c5..dcec50c9e95 100644 --- a/documentation/bugs.sgml +++ b/documentation/bugs.sgml @@ -19,6 +19,10 @@ advanced developers. You can also make a bug report the hard way -- advanced developers will probably prefer this. + + With using either approach report the found issues with relevant + Wine Bugzilla. + The Easy Way @@ -49,11 +53,16 @@ - Post a message to the - comp.emulators.ms-windows.wine - newsgroup with the "Nice Formatted Report" attatched. If - possible, upload the full debug output to a web/ftp - server and provide the address in your message. + Post the bug to + Wine Bugzilla. + Please, search Bugzilla database to check whether your problem is + already found before posting a bug report. + 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. @@ -88,7 +97,8 @@ Compiler and version (run gcc -v) - Windows version, if installed + Windows version, if used with Wine. + Mention if you don't use Windows @@ -133,6 +143,9 @@ please use only +relay!! A bug report with a crash in +snoop 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. To get the trace output, use the following commands: @@ -182,12 +195,13 @@ - Post your report to the newsgroup - comp.emulators.ms-windows.wine + Post the bug to + Wine Bugzilla. + Please, search Bugzilla database to check whether your problem is 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 helpful response should be very good. @@ -201,7 +215,7 @@ If after reading this document there is something you couldn't figure out, or think could be explained better, or that should have been included, please post to - comp.emulators.ms-windows.wine to + Wine Bugzilla to let us know how this document can be improved. diff --git a/documentation/wine.man.in b/documentation/wine.man.in index 0f6e7d34023..e50610c6a7d 100644 --- a/documentation/wine.man.in +++ b/documentation/wine.man.in @@ -106,7 +106,7 @@ winspool, wnet, x11 and x11drv. .PP For more information on debugging messages, see the file -.I documentation/debug-msgs +.I documentation/running.sgml in the source distribution (FIXME: outdated). .RE .TP @@ -313,7 +313,7 @@ Please add entries to this list for applications you currently run. Bug reports and successes may be posted to .I comp.emulators.ms-windows.wine. If you want to post a bug report, please read the file -.I documentation/bugreports +.I documentation/bugs.sgml in the .B wine source to see what information is necessary (FIXME: outdated).