diff options
Diffstat (limited to 'doc/trouble.doc')
| -rw-r--r-- | doc/trouble.doc | 35 |
1 files changed, 23 insertions, 12 deletions
diff --git a/doc/trouble.doc b/doc/trouble.doc index 0fca3b2..541d6cf 100644 --- a/doc/trouble.doc +++ b/doc/trouble.doc @@ -18,6 +18,8 @@ <h2>Known problems:</h2> <ul> +<li>If you have problems building doxygen from sources, please + read \ref unix_problems "this section" first. <li>Doxygen is <em>not</em> a real compiler, it is only a lexical scanner. This means that it can and will not detect errors in your source code. <li>Since it impossible to test all possible code fragments, it is @@ -60,8 +62,8 @@ documentation, because of possible ambiguities or lack of information about the context in which the code fragment is found. <li>It is not possible to insert a non-member function f in a class A - using the \\relates command, if class A already has a member with name f - and the same argument list. + using the \\relates or \\relatesalso command, if class A already + has a member with name f and the same argument list. <li>There is only very limited support for member specialization at the moment. It only works if there is a specialized template class as well. @@ -82,7 +84,15 @@ know why. \anchor bug_reports <h2>How to report a bug</h2> -If you find a bug please send an e-mail to: dimitri@stack.nl. +Bugs are tracked in GNOME's <a href="http://bugzilla.gnome.org">bugzilla</a> database. +Before submitting a +<a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">new bug</a>, +first +<a href="http://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=NEEDINFO&bug_status=REOPENED&bug_status=VERIFIED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&changedin=&chfieldfrom=&chfieldto=Now&chfieldvalue=&short_desc=&short_desc_type=substring&long_desc=&long_desc_type=substring&bug_file_loc=&bug_file_loc_type=substring&status_whiteboard=&status_whiteboard_type=substring&keywords=&keywords_type=anywords&op_sys_details=&op_sys_details_type=substring&version_details=&version_details_type=substring&cmdtype=doit&namedcmd=gnome-libs+past+20+days&newqueryname=&order=Reuse+same+sort+as+last+time&form_name=query"> +check</a> if the same bug has already been submitted by others. +If you believe you have found a new bug, +please <a href="http://bugzilla.gnome.org/enter_bug.cgi?product=doxygen">file it</a>. + If you are unsure whether or not something is a bug, please ask help on the <a href="http://sourceforge.net/mail/?group_id=5971">users mailing list</a> first (subscription is required). @@ -105,21 +115,22 @@ always try to include the following information in your bug report: 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!). If you intend to send more than one file please zip or tar - the files together into a single attachment for easier processing. + the files together into a single file for easier processing. + When reporting a new bug you'll get a chance to attach a file to it + immediately \e after opening the bug. + +You can (and are encouraged to) add a patch for a bug. If you do so +please use PATCH as a keyword in the bug entry form. -If you have ideas (or even better some code or a patch) -how to fix existing bugs and limitations please discuss them on -the <a href="http://sourceforge.net/mail/?group_id=5971">developers mailing list</a>. -Patches can also send directly to dimitri@stack.nl. +If you have ideas how to fix existing bugs and limitations please discuss them on +the <a href="http://sourceforge.net/mail/?group_id=5971">developers mailing list</a> +(subscription required). Patches can also be sent directly to dimitri@stack.nl if +you prefer not to send them via the bug tracker or mailing list. For patches please use "diff -uN" 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. -Note that you can also post bug reports via the bug tracker at -sourceforge, but I do not really like this because of its web -interface, which I find rather clumpsy to use. - */ |