Re: [RFC - Python scripting] New methods Symtab.global_block and Symtab.static_block (docs included)

[Phil Muldoon <pmuldoon at redhat dot com>]

On 04/18/2012 09:49 AM, Siva Chandra wrote:
>>> +@defun Symtab.global_block ()
>>> +Return the global block of the underlying symbol table.  Note that,
>>> +though highly unlikely, the returned @code{gdb.Block} objects are not
>>> +guaranteed to be identical across different @value{GDBN} releases.
>>> +@end defun
>>> +
>>> +@defun Symtab.static_block ()
>>> +Return the static block of the underlying symbol table.  Note that,
>>> +though highly unlikely, the returned @code{gdb.Block} objects are not
>>> +guaranteed to be identical across different @value{GDBN} releases.
>>> +@end defun
> 
> Eli> I think it would be a good idea to have here a cross-reference to
> Eli> "Blocks in Python".
> Eli>
> Eli> Also, the 2 identical sentences about the objects not being preserved
> Eli> across GDB releases should probably be replaced by just one sentence,
> Eli> saying this for both types of blocks.
> 
> Thanks Eli, for taking a look.  I have modified according to your
> comments.  I would like you to take a look at the doc changes again
> since the suggestion wasn't objective for the second change.
> ChangeLog correction pointed to by Phil, and the use of accessor
> macros as suggested by Tom, are also in the attached patch.

FWIW, I would still like to see a clarification of the static/global
documentation regarding the "this might change" comment.  Sorry to be
a stickler on this, but I think it is important we don't start hinting
at API breakages without an adequate explanation as to what may
change, and why.  (Given that there is a need to put that disclaimer
in there in the first place).

Cheers,

Phil