Re: Internals manual fixups

[Stan Shebs <stan at codesourcery dot com>]

Eli Zaretskii wrote:
> > -watchpoints before stepping the inferior.
> > +watchpoints before stepping the inferior. Currently this is only
> > +defined for Solaris x86.
> >     
>
> I generally find text that mentions specific hosts a maintenance
> nightmare: we will have to remember from now on to modify it whenever
> some other platform defines this.  I prefer saying something vague,
> like "on some platforms".
>   
Excellent point. I'll add a comment at the top too.
> > +Returns a @code{(register, offset)} pair representing the virtual
> >     
>
> I think it would be better here to give "register" and "offset" the
> @var markup.
>
>   
> > +frame pointer in use at the code address @var{pc}.
> >     
>
> Btw, saying that this pair "represents the virtual frame pointer"
> seems to be not enough, as the reader is left to wonder what is the
> role of each one of the 2 members of this pair.  Please consider
> adding some more details.
>   
I'm not sure myself, I just reorganized someone else's text. But I'll 
take a look.
> > +(Target header files such as
> > +@file{gdb/config/@var{arch}/tm-@var{ttt}.h},
> > +@file{gdb/config/@var{arch}/tm-@var{arch}.h}, and
> > +@file{config/tm-@var{os}.h} are no longer used.)
> >     
>
> Then why mention them at all?
>   
Those types of files were in use for many years, and still present in 
many versions of GDB. So thinking about it, it seemed that someone 
coming from one of those to current GDB would be looking for those 
files, and wondering what happened. Normally I wouldn't bother to keep 
past bits, but since these files were part of the main porting mechanism 
for GDB for nearly two decades, it seems worth at least noting their 
past existence.
> Otherwise, this is okay.
>   
Thanks!
> Note that I didn't verify that everything you removed is indeed not
> used.
>   
I used to have a little script to find discrepancies, no idea where it 
is now. It was pre-gdbarch, so would have to be rewritten in any case. I 
expect I'll revive it, otherwise it's a painful M x N problem to keep up 
with all the retargeting bits. (Had a script for the user's manual too, 
found a few undocumented commands that way!)

Stan