This is the mail archive of the
gdb-patches@sources.redhat.com
mailing list for the GDB project.
Re: [rfc/rfa:doc] PC_IN_SIGTRAMP; Was: [RFA] Multi-arch IN_SIGTRAMP
> Date: Sun, 21 Apr 2002 13:42:28 -0400
>> From: Andrew Cagney <ac131313@cygnus.com>
>>
>> [Eli, note the doco update]
>
>
Eli, thanks.
It's going in with:
> @item PC_IN_SIGTRAMP (@var{pc}, @var{name})
> @findex PC_IN_SIGTRAMP
> @cindex sigtramp
> The @dfn{sigtramp} is a routine that the kernel calls (which then calls
> the signal handler). On most machines it is a library routine that is
> linked into the executable.
>
> This function, given a program counter value in @var{pc} and the
> (possibly NULL) name of the function in which that @var{pc} resides,
> returns nonzero if the @var{pc} and/or @var{name} show that we are in
> sigtramp.
Andrew
> Thanks for the heads-up.
>
>
>> * gdbint.texinfo (Target Architecture Definition): Replace
>> IN_SIGTRAMP with PC_IN_SIGTRAMP.
>
>
> Approved, with a few minor comments:
>
>
>> +@item PC_IN_SIGTRAMP (@var{pc}, @var{name})
>> +@findex PC_IN_SIGTRAMP
>> +Sigtramp is a routine that the kernel calls
>
>
> Here you introduce a new term. It is best to give it a @dfn markup,
> so that it stands out, and add an index entry for it, so that someone
> who bumps into this term elsewhere in the manual could find its
> definition. So:
>
> @item PC_IN_SIGTRAMP (@var{pc}, @var{name})
> @findex PC_IN_SIGTRAMP
> @cindex sigtramp
> A @dfn{sigtramp} is a routine that the kernel calls...
>
>
>> +This function, given a program counter value and the (possibly NULL)
>
>
> "NULL" should be in @code, since it's a C symbol.
>
> Also, it's better to say "... given a program counter value in
> @var{pc}...", since this immediately explains what is @var{pc}.
>
> Thanks.
>