[RFA/commit] Add documentation for TARGET_OBJECT_OSDATA

Joel Brobecker
2010-12-28T14:34:01Z

> BZZT. Don't do that. The return of a TARGET_OBJECT_OSDATA request
> should be a table that follows the gdb/features/osdata.dtd dtd. It
> is meant as data to be fed into the "info os" command (and a non-submitted
> -info-os MI command).

I propose to expand the comment besides TARGET_OBJECT_OSDATA to make it
clear...

gdb/ChangeLog:

* target.h (enum target_object): Expand the documentation of
TARGET_OBJECT_OSDATA a bit.

Looks good?

Thanks,
--
Joel

---
gdb/target.h | 3 ++-
1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/gdb/target.h b/gdb/target.h
index ea27b2c..6a1ec92 100644
--- a/gdb/target.h
+++ b/gdb/target.h
@@ -256,7 +256,8 @@ enum target_object
/* Currently loaded libraries, in XML format. */
TARGET_OBJECT_LIBRARIES,
/* Get OS specific data. The ANNEX specifies the type (running
- processes, etc.). */
+ processes, etc.). The data being transfered is expected to follow
+ the DTD specified in features/osdata.dtd. */
TARGET_OBJECT_OSDATA,
/* Extra signal info. Usually the contents of `siginfo_t' on unix
platforms. */
--
1.7.1