From: Keith Marshall Date: Fri, 19 Nov 2021 22:58:22 +0000 (+0000) Subject: Publish bug reporting guidelines. X-Git-Url: http://git.osdn.net/view?p=mingw%2Fwebsite.git;a=commitdiff_plain;h=be527723fb87694bfeb480cea1ca440c1a59ffdc Publish bug reporting guidelines. * buginfo.html: New file. * contact.html (Reporting Bugs): Update reference text. * faq.html docrefs.html: Add reference links. --- diff --git a/buginfo.html b/buginfo.html new file mode 100644 index 0000000..aca8f88 --- /dev/null +++ b/buginfo.html @@ -0,0 +1,429 @@ + + +

So you think you have found a bug and would like to report the problem? +Before reporting a bug please ensure you have applied all applicable updates +to your build environment, and also search the MinGW.OSDN mail archives, and the MinGW.OSDN “Issues” ticket system, +to ensure the bug has not already been reported, +or if a temporary workaround has been suggested. +(When searching within the ticket system, +please ensure that you include “Closed” tickets; +it may be that a solution is already available, +pending a future release). +

+

To ensure that your report will be given the utmost attention, +please read and follow the guidelines below. +These are provided for your benefit, +as non‑compliance may result in rejection of your bug report. +Although they apply, in this specific context, +to reporting via the MinGW.OSDN ticket system, +these recommendations are typical of any bug reporting process. +

+ +
+

Guidelines for Submission of Bug Reports

+

For general guidance on How to Report Bugs Effectively, +you are encouraged to read this treatise by Simon Tatham. +Do note, however, that to report MinGW bugs, +you should use the reporting facilities documented below; +do not report MinGW bugs to Simon — +he is unlikely to be interested. +

+

When reporting a bug to one of the +MinGW mailing lists +or to the MinGW Issues ticket system on OSDN.net, +please include as much as possible of the following information, +pertinent to the problem: +

+ + + + + + + + + + + + + + +
+ +
+

Generic Package Bugs

+

Under certain circumstances +you may find a bug in a base package, such as MinGW‑GCC, +that is platform independent (i.e. it can be reproduced +on a platform other than one running a Windows operating system). +In this situation please generate a simple test case +that illustrates the bug using only standard headers and libraries +and submit the bug report, following the procedure detailed above, +prior to submitting it to the primary maintainers. +

+

After receiving verification, +from a MinGW developer, +that the bug is indeed platform independent, +please use the appropriate bug tracker or mailing list +to inform the package maintainers. +It is in everyone's best interest that you try to use +the package maintainers' standard methods +and procedures for bug submission. +Avoid submitting bugs specific to a port, +or application that is not a part of the primary package, +to any mailing list other than the +MinGW-Users list. +If you are uncertain about bug submission to another package maintainer, +please seek assistance on the +MinGW-Users list. +

+
+ +
+

Posting a Bug Report

+

Please post bug reports using the +MinGW Issues ticket system, +(hosted within OSDN.net's bug reporting system). +You will need a OSDN.net login account to post; +if you don't have one then click here to register for one. +

+

Please refrain from posting bug reports to the mailing list; +we tend to lose track of bug reports posted there! +If you have a specific question regarding making the bug report, +then please use the MinGW-Users mailing list +to ask. +

+
+ +
+

In Case of Difficulty

+

If you have difficulty in understanding, +or cannot furnish information to satisfy the above requirements, +please ask for help on the MinGW-Users mailing list. +

+
+ + diff --git a/contact.html b/contact.html index 3fcc1d0..d1f9165 100644 --- a/contact.html +++ b/contact.html @@ -181,6 +181,18 @@ please use the “Preview” facility to check for, and correct, any markup errors; (these are, alas, all too common, and create a bad impression of the reporter). +Pay particular attention to in‑line program code references, +or program code examples, +(whether in‑line, or multi‑line code blocks); +these must  be enclosed in triple‑brace  +mark‑up, either as in‑line formatted text,  +or as formatted text blocks , as appropriate; +(please see the OSDN.net formatting guide, +and be aware that the use of fixed pitch,  +as introduced by back‑tick  mark‑up, +generally isn’t  a satisfactory alternative). Finally, when you are satisfied, click the “Submit” button to complete the ticket submission process.

diff --git a/docrefs.html b/docrefs.html index 66a5b97..c70cce8 100644 --- a/docrefs.html +++ b/docrefs.html @@ -102,6 +102,9 @@ HOWTO Export a Multiple Instance Supporting C++ Class from a DLL
HOWTO Work Around a Linker Lock-Up Problem in Windows‑7
+
+HOWTO Submit an Effective MinGW Bug Report +
diff --git a/faq.html b/faq.html index 2ae6cfc..a482894 100644 --- a/faq.html +++ b/faq.html @@ -472,6 +472,26 @@ level of optimization; (however, you should not allow this, if successful, to discourage you from reporting the issue).

+ +
+

Firstly, +you should double check your own code, +to ensure that it is completely valid; +sadly, +many submitted bug reports turn out to result from user error, +so if you are in any  doubt, +we recommend that you seek advice from +the MinGW‑Users mailing list community, +before  filing a formal bug report. +

+

If you do  decide to submit a formal bug report, +you should proceed as advised in +these bug reporting guidelines. +

+

Software Portability Issues