This is the mail archive of the gdb-patches@sources.redhat.com mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[commit/doc] Document KOD commands (was: show os)


It turned out that the manual doesn't have index entries for set/show
os and doesn't describe "show os" at all.  I committed the following
to fix that.

While at that, I also removed one of the index entry "kernel object",
since the other index entry, "kernel object display" begins with the
same 2 words and points to the same place.  Thus, if a user types
"i kernel object RET" in an Infio reader, she will land on the right
spot even if we have only the "kernel object display" entry in the
index.

Btw, it seems to me that the text displayed by "help show os" leaves
a lot to be desired.  At least we should tell that it's relevant to
KOD, to prevent users from thinking they should see the name of their
host/target OS there.  Thoughts?

2004-01-24  Eli Zaretskii  <eliz@gnu.org>

	* gdb.texinfo (KOD): Document "show os".  Add index entries for
	"set/show os" and "info cisco" commands.

Index: src/gdb/doc/gdb.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdb.texinfo,v
retrieving revision 1.188
diff -u -r1.188 gdb.texinfo
--- src/gdb/doc/gdb.texinfo	20 Jan 2004 00:50:05 -0000	1.188
+++ src/gdb/doc/gdb.texinfo	24 Jan 2004 11:35:26 -0000
@@ -10632,9 +10632,7 @@
 
 @node KOD
 @section Kernel Object Display
-
 @cindex kernel object display
-@cindex kernel object
 @cindex KOD
 
 Some targets support kernel object display.  Using this facility,
@@ -10643,6 +10641,7 @@
 mutexes and other synchronization objects.  Exactly which objects can be
 displayed is determined on a per-OS basis.
 
+@kindex set os
 Use the @code{set os} command to set the operating system.  This tells
 @value{GDBN} which kernel object display module to initialize:
 
@@ -10650,11 +10649,17 @@
 (@value{GDBP}) set os cisco
 @end smallexample
 
+@kindex show os
+The associated command @code{show os} displays the operating system
+set with the @code{set os} command; if no operating system has been
+set, @code{show os} will display an empty string @samp{""}.
+
 If @code{set os} succeeds, @value{GDBN} will display some information
 about the operating system, and will create a new @code{info} command
 which can be used to query the target.  The @code{info} command is named
 after the operating system:
 
+@kindex info cisco
 @smallexample
 (@value{GDBP}) info cisco
 List of Cisco Kernel Objects
@@ -10665,8 +10670,10 @@
 Further subcommands can be used to query about particular objects known
 by the kernel.
 
-There is currently no way to determine whether a given operating system
-is supported other than to try it.
+There is currently no way to determine whether a given operating
+system is supported other than to try setting it with @kbd{set os
+@var{name}}, where @var{name} is the name of the operating system you
+want to try.
 
 
 @node Remote Debugging


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]