summaryrefslogtreecommitdiffstats
path: root/doc/trouble.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2001-01-21 19:05:35 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2001-01-21 19:05:35 (GMT)
commit41e1827f53fa1b9ef018b378f8aca4e4fec6750a (patch)
treec28a8c29b3e53508bef2ee53a06b7c4ac6925fe9 /doc/trouble.doc
parent583cc3299ac171f473e4221b0b535ea616e4db03 (diff)
downloadDoxygen-41e1827f53fa1b9ef018b378f8aca4e4fec6750a.zip
Doxygen-41e1827f53fa1b9ef018b378f8aca4e4fec6750a.tar.gz
Doxygen-41e1827f53fa1b9ef018b378f8aca4e4fec6750a.tar.bz2
Release-1.2.4-20010121
Diffstat (limited to 'doc/trouble.doc')
-rw-r--r--doc/trouble.doc37
1 files changed, 21 insertions, 16 deletions
diff --git a/doc/trouble.doc b/doc/trouble.doc
index 9aaf44b..f03eb99 100644
--- a/doc/trouble.doc
+++ b/doc/trouble.doc
@@ -78,26 +78,31 @@ If you are trying Doxygen let me know what you think of it (do you
miss certain features?). Even if you decide not to use it, please let me
know why.
-Furthermore, I would appreciate a mail if you have found
-a bug, or if you have ideas (or even better some code or a patch)
-how to fix existing bugs and limitations. For patches please use
-"diff -u"
-
<h2>How to report a bug</h2>
-If you think you have found a bug in doxygen, please report it so I can
-fix it.
+I would appreciate an e-mail if you have found
+a bug, or if you have ideas (or even better some code or a patch)
+how to fix existing bugs and limitations. For patches please use
+"diff -u" or include the files you modified. If you send more than
+one file please tar or zip everything, so I only have to save and download
+one file.
-Always include the following information in your bug report:
-- The version of doxygen you are using.
-- The name and version number of your operating system
+Always try to include the following information in your bug report:
+- The version of doxygen you are using (for instance 1.2.4).
+- The name and version number of your operating system (for instance
+ SuSE Linux 6.4)
+- It is usually a good idea to send along the configuation file as well,
+ but please use doxygen with the <code>-s</code> flag while generating it
+ to keep it small.
+- The easiest way for me to solve bugs is if you can send me a small example
+ demonstrating the problem you have. Please make sure the example is valid
+ source code (could potentially compile) and that the problem is really
+ captured by the example (I often get examples that do not trigger the
+ actual bug!).
-The easiest way for me to solve bugs is if you can send me a small example
-demonstrating the problem you have. Please make sure the example is valid
-source code (try compiling it) and if the problem is really captured by
-the example.
-It is usually a good idea to send along the configuation file as well,
-but please use doxygen with the <code>-s</code> flag while generating it.
+If you send only a (vague) description of a bug, you are usually not very
+helpful and will costs me much more time to figure out what you mean.
+In the worst-case your bug report may even be completely ignored by me!
My e-mail address: <a href="mailto:dimitri@stack.nl">dimitri@stack.nl</a>
*/