Re: [doc] improve MI varobj introduction

Eli Zaretskii
2007-01-04T21:48:16Z

> From: Vladimir Prus <ghost@cs.msu.su>
> Date: Thu, 04 Jan 2007 21:23:00 +0300
>
> Here's the final patch.

Thanks. I have a few comments and suggestions.

> -When returning the actual values of the objects, this facility allows
> -for the individual selection of the display format used in the result
> -creation. It can be chosen among: binary, decimal, hexadecimal, octal
> -and natural. Natural refers to a default format automatically
> -chosen based on the variable type (like decimal for an @code{int}, hex
> -for pointers, etc.).

This fragment was removed, but the new text doesn't mention this
feature at all. Was the old text plain wrong (i.e. there's no such
feature)? If the feature does exist, I think it should be mentioned.

> +Variable object is MI interface to work with expressions.

Perhaps it's an interface to work with named expressions, because I
believe you don't need anything to work with just expressions, do you?

> +object operations -- for example to obtain or change the value of

Please use 3 dashes in a row, and without blanks on either side, to
get an em-dash in the printed version.

> +Variable objects have hierarchical structure.

The original text said it was a tree structure. I suggest to add the
``tree'' part back (i.e. ``hierarchical tree structure''), as
otherwise it is not clear why you talk about leaf variables further
down.

> Child variable objects can children themself,
> +util we reach leaf variable objects of built-in types. ^^^^^^^^
^^^^
Typos, and also something's wrong with this sentence in general.

> +obtained for a non-leaf variable object, but its generally a string
^^^
"it's"

> +that only indicates the type of the object, and does not list its
> +content.
^^^^^^^
"contents".

> +A frontend need not read the values of all variable objects each time
^^^^^^^^
"does not need"

> +the program stops. Instead, MI provides update command that lists all
^^^^^^^^^^^^^^
"an update command"

> +variable objects which values has changed since the last update
^^^^^^^^^^^^
"whose values"

> +list of variable objects which values have changed. Here,
^^^^^^^^^^^^
Ditto.