cdc7d7020be1774c1d7c023eaf64532cd7f92e3c
[gpg4win.git] / doc / website / reporting-bugs.htm4
1 m4_dnl -*-html-*-
2 m4_include(`template.m4')
3 m4_dnl $Id$
4
5 m4_define(`EN')
6 m4_define(`DE_FILE', `reporting-bugs-de.html')
7 PAGE_START
8
9 <h1>How to report a problem</h1>
10
11 <h2>1. Check whether you are using the newest version of Gpg4win</h2>
12
13 <p>
14 The download button ontop of the Gpg4win homepage shows
15 the current version of Gpg4win.
16 </p>
17
18 <!--
19 <p>
20 TODO: Where can you see the version number of a installed
21 package?
22 </p>
23 -->
24
25 <h2>2. Check whether it is really a Gpg4win bug</h2>
26
27 <p>
28 Gpg4win integrates a number of tools that are
29 actually maintained by other development teams.
30 </p>
31
32 <p>
33 Therefore problems and bugs of general nature,
34 i.e. not related to the cross-compilation and/or
35 packaging by the Gpg4win team, should be reported
36 to the respective project teams (usually you need to
37 register before submitting or commenting a bug):
38 </p>
39
40 <ul>
41 <li><a href="http://www.stud.uni-hannover.de/~twoaday/bugs.html">
42     WinPT bug tracking</a>
43      <p>
44 <li><a href="http://wald.intevation.org/tracker/?group_id=13">
45     GPA bug tracking</a>
46      <p>
47 <li><a href="http://www.excelcia.org/modules.php?name=Forums&file=viewforum&f=1">
48     GPGee Forum</a> (GPGee has no bug tracker, users are asked to report
49     problems in the forum)
50      <p>
51 <li><a href="http://www.thewildbeast.co.uk/sylpheed-claws/bugzilla/index.cgi">
52     Sylpheed-Claws bug tracking</a>
53      <p>
54 <li><a href="http://www.gnupg.org/(en)/documentation/bts.html">
55     GnuPG and GPGol bug tracking</a>
56 </ul>
57
58 <p>
59 Of course, it is not always easy to decide whether
60 it is a bug of Gpg4win or a module.
61 In these cases and depending on the type of the
62 problem, either ask on one of the Gpg4win forums
63 or mailing lists for advice or create a Gpg4win bug report.
64 </p>
65
66
67 <h2>3. Check whether the problem is already reported</h2>
68
69 <p>
70 Search through the list of open bugs and try to
71 identify whether one of the entries already describes
72 your problem. Add your additional comments there.
73 </p>
74
75 <h2>4. Provide version number</h2>
76
77 <p>
78 If you report a new bug or add comments to a existing
79 bug report, describe the exact version of the Windows System,
80 Gpg4win, and if appropriate of MS Office and Outlook.
81 </p>
82
83 <h2>5. Notes how to reproduce the bug</h2>
84
85 <p>
86 If possible provide a step by step method
87 how you reproduce the bug.
88 </p>
89
90 <h2>6. Add debug information</h2>
91
92 <p>
93 If appropriate, attach a debug log of the
94 procedure where you produced the bug.
95 </p>
96
97 <h3>Creating debug log information</h3>
98
99 <p>
100 GPGol has an extra debug options which helps to understand the
101 internal communication between Outlook and GPGol.
102 To enable it, go to the GnuPG tab in Outlook's option page, click on
103 the "Advanced" button and enter
104 </p>
105
106 <pre>
107 c:\temp\gpgol.log
108 </pre>
109
110 <p>
111 into the "Debug output" field.
112 </p>
113
114 <p>
115 If you feel able to, just send a excerpt with the relevant
116 information.
117 </p>