Re: [rfa:doco] Coding: Per-architecture data-pointers

[Eli Zaretskii <eliz at is dot elta dot co dot il>]

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.