From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gdb-patches-return-15536-listarch-gdb-patches=sourceware.cygnus.com@sources.redhat.com>
Received: (qmail 27482 invoked by alias); 15 May 2002 05:32:17 -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 27464 invoked from network); 15 May 2002 05:32:15 -0000
Received: from unknown (HELO is.elta.co.il) (199.203.121.2)
  by sources.redhat.com with SMTP; 15 May 2002 05:32:15 -0000
Received: from is (is [199.203.121.2])
	by is.elta.co.il (8.9.3/8.8.8) with SMTP id IAA01166;
	Wed, 15 May 2002 08:30:20 +0300 (IDT)
Date: Tue, 14 May 2002 22:32:00 -0000
From: Eli Zaretskii <eliz@is.elta.co.il>
X-Sender: eliz@is
To: Andrew Cagney <ac131313@cygnus.com>
cc: gdb-patches@sources.redhat.com
Subject: Re: [rfa:doco] Coding: Per-architecture data-pointers
In-Reply-To: <3CE1E99F.6070005@cygnus.com>
Message-ID: <Pine.SUN.3.91.1020515082418.607G-100000@is>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
X-SW-Source: 2002-05/txt/msg00584.txt.bz2


On Wed, 15 May 2002, Andrew Cagney wrote:

> The attatched attempts to document the ``correct'' way to create 
> per-architecture module data-pointers.

Approved, with a few comments:

> +@cindex data-pointer, per-architecture
> +@cindex data-pointer, per-module

It is not useful to have two index entries which begin the same and point 
to the same page.  If you think we need to mention both per-architecture 
and per-module here, I suggest something like this:

  @cindex data-pointer, per-architecture/per-module

> +@smallexample
> +static struct gdbarch_data *nozle_data_handle;
> +static void *nozel_data_init (struct gdbarch *gdbarch);
> +static void nozel_data_free (struct gdbarch *gdbarch, void *data);

Watch for too-long lines here ;-)  Lines longer than 64 characters (from 
memory) might cause TeX to whine.

> +The per-architecture data-pointer is accessed using @code{gdbarch_data}

A period is missing here.

> +The function @code{set_gdbarch_data} is can be used to modify a

Something is wrong with "is can be used" here.

> +@var{pointer}.  If the previous data-pointer value is non-NULL, then it

NULL should be in @code.