From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-14515-listarch-gdb-patches=sourceware.cygnus.com@sources.redhat.com>
Received: (qmail 28896 invoked by alias); 21 Apr 2002 19:16:27 -0000
Mailing-List: contact gdb-patches-help@sources.redhat.com; run by ezmlm
Precedence: bulk
List-Subscribe: <mailto:gdb-patches-subscribe@sources.redhat.com>
List-Archive: <http://sources.redhat.com/ml/gdb-patches/>
List-Post: <mailto:gdb-patches@sources.redhat.com>
List-Help: <mailto:gdb-patches-help@sources.redhat.com>, <http://sources.redhat.com/ml/#faqs>
Sender: gdb-patches-owner@sources.redhat.com
Received: (qmail 28862 invoked from network); 21 Apr 2002 19:16:24 -0000
Received: from unknown (HELO frigg.inter.net.il) (192.114.186.16)
  by sources.redhat.com with SMTP; 21 Apr 2002 19:16:24 -0000
Received: from zaretsky ([80.230.2.40])
	by frigg.inter.net.il (Mirapoint Messaging Server MOS 2.9.3.2)
	with ESMTP id BIQ04833;
	Sun, 21 Apr 2002 22:16:04 +0300 (IDT)
Date: Sun, 21 Apr 2002 12:16:00 -0000
From: "Eli Zaretskii" <eliz@is.elta.co.il>
To: ac131313@cygnus.com
Message-Id: <8011-Sun21Apr2002221607+0300-eliz@is.elta.co.il>
CC: davem@redhat.com, gdb-patches@sources.redhat.com
In-reply-to: <3CC2FA04.50605@cygnus.com> (message from Andrew Cagney on Sun,
	21 Apr 2002 13:42:28 -0400)
Subject: Re: [rfc/rfa:doc] PC_IN_SIGTRAMP; Was: [RFA] Multi-arch IN_SIGTRAMP
Reply-to: Eli Zaretskii <eliz@is.elta.co.il>
References: <20020421.011153.14656372.davem@redhat.com> <3CC2FA04.50605@cygnus.com>
X-SW-Source: 2002-04/txt/msg00736.txt.bz2

> Date: Sun, 21 Apr 2002 13:42:28 -0400
> From: Andrew Cagney <ac131313@cygnus.com>
> 
> [Eli, note the doco update]

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.