From a7ba28fd1f3c094aa878b779b883ea185dcaa10e Mon Sep 17 00:00:00 2001 From: Ralf Wildenhues Date: Thu, 14 Oct 2010 06:14:20 +0200 Subject: [PATCH] Add FAQ entry for bug reporting instructions. * doc/automake.texi (Reporting Bugs): New section. (Introduction): Refer to it. Signed-off-by: Ralf Wildenhues --- ChangeLog | 6 ++++++ doc/automake.texi | 44 ++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 48 insertions(+), 2 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7883d5eb1..18c5ff6bc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2010-11-01 Ralf Wildenhues + + Add FAQ entry for bug reporting instructions. + * doc/automake.texi (Reporting Bugs): New section. + (Introduction): Refer to it. + 2010-10-04 Stefano Lattarini Add support for newer python versions. diff --git a/doc/automake.texi b/doc/automake.texi index 8848dcd40..b75c7a5e7 100644 --- a/doc/automake.texi +++ b/doc/automake.texi @@ -343,6 +343,7 @@ Frequently Asked Questions about Automake * Multiple Outputs:: Writing rules for tools with many output files * Hard-Coded Install Paths:: Installing to hard-coded locations * Debugging Make Rules:: Strategies when things don't work as expected +* Reporting Bugs:: Feedback on bugs and feature requests History of Automake @@ -424,8 +425,7 @@ to be built. @cindex Reporting bugs @cindex E-mail, bug reports -Mail suggestions and bug reports for Automake to -@email{@value{PACKAGE_BUGREPORT}}. +For more information on bug reports, @xref{Reporting Bugs}. @node Autotools Introduction @chapter An Introduction to the Autotools @@ -10351,6 +10351,7 @@ lists. * Multiple Outputs:: Writing rules for tools with many output files * Hard-Coded Install Paths:: Installing to hard-coded locations * Debugging Make Rules:: Strategies when things don't work as expected +* Reporting Bugs:: Feedback on bugs and feature requests @end menu @node CVS @@ -11691,6 +11692,45 @@ a debugger. @end itemize +@node Reporting Bugs +@section Reporting Bugs + +Most nontrivial software has bugs. Automake is no exception. Although +we cannot promise we can or will fix a bug, and we might not even agree +that it is a bug, we want to hear about problems you encounter. Often we +agree they are bugs and want to fix them. + +To make it possible for us to fix a bug, please report it. In order to +do so effectively, it helps to know when and how to do it. + +Before reporting a bug, it is a good idea to see if it is already known. +You can look at the @uref{http://debbugs.gnu.org/, GNU Bug Tracker} +and the @uref{http://lists.gnu.org/@/archive/@/html/@/bug-automake/, +bug-automake mailing list archives} for previous bug reports. We +previously used a +@uref{http://sourceware.org/@/cgi-bin/@/gnatsweb.pl?database=automake, +Gnats database} for bug tracking, so some bugs might have been reported +there already. Please do not use it for new bug reports, however. + +If the bug is not already known, it should be reported. It is very +important to report bugs in a way that is useful and efficient. For +this, please familiarize yourself with +@uref{http://www.chiark.greenend.org.uk/@/~sgtatham/@/bugs.html, How to +Report Bugs Effectively} and +@uref{http://catb.org/@/~esr/@/faqs/@/smart-questions.html, How to Ask +Questions the Smart Way}. This helps you and developers to save time +which can then be spent on fixing more bugs and implementing more +features. + +For a bug report, a feature request or other suggestions, please send +email to @email{@value{PACKAGE_BUGREPORT}}. This will then open a new +bug in the @uref{http://debbugs.gnu.org/@/automake, bug tracker}. Be +sure to include the versions of Autoconf and Automake that you use. +Ideally, post a minimal @file{Makefile.am} and @file{configure.ac} that +reproduces the problem you encounter. If you have encountered test +suite failures, please attach the @file{tests/test-suite.log} file. + + @node History @chapter History of Automake -- 2.47.2