[doc patch] gdbint: XFAIL vs. KFAIL [Re: [patch] gcc KFAILs to XFAILs]

[Jan Kratochvil <jan.kratochvil@redhat.com>]

On Wed, 14 Dec 2011 20:28:15 +0100, Doug Evans wrote:
> Can someone check into gdbint.texi definitions of xfail and kfail?
> There's a section "Writing Tests", seems like an appropriate place.

FYI I wanted to add it to
	http://sourceware.org/gdb/wiki/GDBTestcaseCookbook
but it already states:
	Known failing new testcases must produce KFAIL (GDB problem) or XFAIL
	(environment problem). 

Not going to check it in without the doc review.


Thanks,
Jan


gdb/doc/
2011-12-14  Jan Kratochvil  <jan.kratochvil@redhat.com>

	* gdbint.texinfo (Testsuite): Describe KFAIL and XFAIL in Writing
	tests.

--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -7846,6 +7846,20 @@ instance, some @value{GDBN} bugs involving the display of source lines would
 never manifest themselves if the programs used GNU coding style
 uniformly.
 
+Some testcase results need more detailed explanation:
+
+@table @code
+@item KFAIL
+Known problem of @value{GDBN} itself.  You must specify the @value{GDBN} bug
+report number.
+
+@item XFAIL
+Known problem of environment.  This typically includes @value{NGCC} but it
+includes also many other system components which cannot be fixed in the
+@value{GDBN} project.  You should provide bug report number for the failing
+component of the environment, if such bug report is available.
+@end table
+
 @node Hints
 
 @chapter Hints