[PATCH] Document board settting

Yao Qi
2012-04-24T15:05:05Z

This patch is to describe all the existing board settings we are using
in GDB testsuite. Some of them are obvious, but some are not. I
referred CVS log and mail archives to get the description to each
of them.

I comment out gdb,noresults and use_cygmon, which I can't figure out
the purpose of using them. I'll figure them out later.
Please pay attention to my explanation to "gdb,nofileio" and
"gdb,noinferiorio". I am not satisfied with them, but unable
to tell the difference of them.

gdb/doc:

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

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

diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index fcc106c..80196b8 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -7873,6 +7873,62 @@ 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 its board
+file by means of @dfn{Boarding Settings}. Here are the board settings,
+
+@table @code
+
+@item gdb,cannot_call_functions
+Whether the board supports inferior call, that is, invoking inferior functions
+in @value{GDBN}. If inferior call is required in test case, this variable
+should be checked.
+@item gdb,can_reverse
+Whether the board supports reverse execution. If reverse execution is required
+in test case, this variable should be checked.
+@item gdb,no_hardware_watchpoints
+Whether the board supports hardware watchpoints. If hardware watchpoints
+are required in test case, this variable should be checked.
+@item gdb,nofileio
+Whether the remote stub intercept target file operations and perform them on
+the host.
+@item gdb,noinferiorio
+Whether the inferior has I/O capability on the board. If test case has to do
+some operations related to I/O, such as printing, this variable should be
+checked.
+@c @item gdb,noresults
+@c NEED DOCUMENT.
+@item gdb,nosignals
+Whether signals are supported on target board. If test case uses signals,
+this variable should be checked.
+@item gdb,skip_huge_test
+Whether to skip time-consuming tests on the board with slow connection. If
+test case is time-consuming, this variable should be checked.
+@item gdb,skip_float_tests
+Whether to skip tests related to float points on target board. If the test
+cases use floating points, this variable should be checked.
+@item gdb,use_precord
+Whether support process record on target board. If the test case use target
+record, this variable should be checked.
+@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.
+@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.
+@item noargs
+Whether configuration of @value{GDBN} supports argument passing for inferior.
+If the test case needs argument passing, this variable should be checked.
+@item no_long_long
+Whether target board supports type @code{long long}. If test case uses
+@code{long long}, this variable should be checked.
+@c @item use_cygmon
+@c NEED DOCUMENT.
+@item use_gdb_stub
+Whether the tests are running with gdb stub.