Re: [PATCH] Document board settting

[Yao Qi <yao at codesourcery dot com>]

On 04/25/2012 02:20 PM, Eli Zaretskii wrote:
>> >                                               If reverse execution is required
>> > +in test case, this variable should be checked.
> Please fix this (and other similar places) as I suggested above.
> 

Fixed.

> Btw, I don't think it's a good idea to repeat the same sentence "If
> FOO is required in a test case, this variable should be checked." for
> every setting.  I think you should only state this once.
> 

I also felt odd when repeating this sentence time and time again in
doc.  In this version, they are removed, and I add a new sentence out
of the table.

"If the feature which is about the board setting variable is required
 in test cases, the corresponding board setting variable should be
 checked in test cases."

>> > +@item gdb_server_prog
>> > +The location of GDBserver.  If GDBserver somewhere other than its default
>> > +location is used in test, specify the location of GDBserver in this variable.
> By "location" you mean the full file name, right?  If so, please say
> so explicitly.  "Location" is ambiguous.

Either full file name or path relative to $build_dir/testsuite should
be OK.  I changed this part to explicitly point this out.

-- 
Yao (éå) 

gdb/doc:

2012-04-25  Yao Qi  <yao@codesourcery.com>

	* gdbint.texinfo (Testsuite): New section `Board settings'.
---
 gdb/doc/gdbint.texinfo |   51 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 51 insertions(+), 0 deletions(-)

diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index fcc106c..750321d 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -7873,6 +7873,57 @@ gdb_test "python print ttype.template_argument(2)" "&C::c"
 @end smallexample
 @end table
 
+@section Board settings
+In @value{GDBN} testsuite, the tests can be configured or customized in the board
+file by means of @dfn{Board Settings}.  Here are the supported board settings:
+
+If the feature which is about the board setting variable is required in test
+cases, the corresponding board setting variable should be checked in test cases.
+
+@table @code
+
+@item gdb,cannot_call_functions
+The board does not support inferior call, that is, invoking inferior functions
+in @value{GDBN}.
+@item gdb,can_reverse
+The board supports reverse execution.
+@item gdb,no_hardware_watchpoints
+The board does not support hardware watchpoints.
+@item gdb,nofileio
+@value{GDBN} is unable to intercept target file operations in remote and perform
+them on the host.
+@item gdb,noinferiorio
+The board is unable to provide I/O capability to the inferior.
+@c @item gdb,noresults
+@c NEED DOCUMENT.
+@item gdb,nosignals
+The board does not support signals.
+@item gdb,skip_huge_test
+Skip time-consuming tests on the board with slow connection.
+@item gdb,skip_float_tests
+Skip tests related to float points on target board.
+@item gdb,use_precord
+The board supports process record.
+@item gdb_server_prog
+The location of GDBserver.  If GDBserver somewhere other than its default
+location is used in test, specify the location of GDBserver in this variable.  The
+location can be either the full file name of GDBserver, or the path relative to
+testsuite directory in build dir.
+@item in_proc_agent
+The location of in-process agent.  If in-process agent other than its default
+location is used in test, specify the location of in-process agent in
+this variable.  The location can be either the full file name or the path relate
+to testsuite directory in build dir.
+@item noargs
+@value{GDBN} does not support argument passing for inferior.
+@item no_long_long
+The board does not support type @code{long long}.
+@c @item use_cygmon
+@c NEED DOCUMENT.
+@item use_gdb_stub
+The tests are running with gdb stub.
+@end table
+
 @node Hints
 
 @chapter Hints
-- 
1.7.0.4