From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 30827 invoked by alias); 24 Apr 2002 16:23:47 -0000 Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm Precedence: bulk List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sources.redhat.com Received: (qmail 30819 invoked from network); 24 Apr 2002 16:23:45 -0000 Received: from unknown (HELO localhost.redhat.com) (216.138.202.10) by sources.redhat.com with SMTP; 24 Apr 2002 16:23:45 -0000 Received: from cygnus.com (localhost [127.0.0.1]) by localhost.redhat.com (Postfix) with ESMTP id 3CBD63D26; Wed, 24 Apr 2002 12:23:44 -0400 (EDT) Message-ID: <3CC6DC10.6010205@cygnus.com> Date: Wed, 24 Apr 2002 09:23:00 -0000 From: Andrew Cagney User-Agent: Mozilla/5.0 (X11; U; NetBSD macppc; en-US; rv:0.9.9) Gecko/20020328 X-Accept-Language: en-us, en MIME-Version: 1.0 To: Eli Zaretskii Cc: davem@redhat.com, gdb-patches@sources.redhat.com Subject: Re: [rfc/rfa:doc] PC_IN_SIGTRAMP; Was: [RFA] Multi-arch IN_SIGTRAMP References: <20020421.011153.14656372.davem@redhat.com> <3CC2FA04.50605@cygnus.com> <8011-Sun21Apr2002221607+0300-eliz@is.elta.co.il> Content-Type: text/plain; charset=us-ascii; format=flowed Content-Transfer-Encoding: 7bit X-SW-Source: 2002-04/txt/msg00947.txt.bz2 > Date: Sun, 21 Apr 2002 13:42:28 -0400 >> From: Andrew Cagney >> >> [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. >