[rfa/doc] Updates to gdbint.texinfo

Andrew Cagney
2001-06-29T11:19:00Z

Hello,

Attatched is a revised patch to doc/gdbint.texinfo that expands on
things like GDB's coding standard. I think I've addressed all the
problems pointed out by Eli and Elena.

I've even managed to type the word all^(*&^(*&, al*(%&%&oca(),
&*^(*all*&^(&*oca().

Probably the most striking thing about this patch is where I delete the
section that gave the thumbs up to adding something like:

#ifdef SOME_TARGET/HOST_DEPENDENCY
do something obscure;
#endif

to core code.

I might try a few more updates over the weekend.

Andrew
From eliz@is.elta.co.il Fri Jun 29 12:22:00 2001
From: "Eli Zaretskii" <eliz@is.elta.co.il>
To: ac131313@cygnus.com
Cc: gdb-patches@sources.redhat.com
Subject: Re: [rfa/doc] Updates to gdbint.texinfo
Date: Fri, 29 Jun 2001 12:22:00 -0000
Message-id: <1483-Fri29Jun2001221859+0300-eliz@is.elta.co.il>
References: <3B3CC68E.3040504@cygnus.com>
X-SW-Source: 2001-06/msg00534.html
Content-length: 1058

> Date: Fri, 29 Jun 2001 14:18:54 -0400
> From: Andrew Cagney <ac131313@cygnus.com>
>
> Attatched is a revised patch to doc/gdbint.texinfo that expands on
> things like GDB's coding standard. I think I've addressed all the
> problems pointed out by Eli and Elena.

Thanks. This is okay, except for the following nitpicking:

> + @emph{Pragmatics: By using these functions, the need to check every
> + memory allocation is removed. These functions provide portable
> + behavour.}

There's a typo in the last word.

> ! Pointers are declared using the traditional K&R C style:
> !
> ! @example
> ! void *foo;
> ! @end example
> !
> ! and not:
>
> + @example
> + void * foo;
> + void* foo;
> + @end example

The "and not:" part above needs a @noindent before it.

> + @subsection File Names
> +
> + Any file that is used to build @value{GDBN} on either DJGPP or Cygwin
> + must be 8.3 compliant.

I suggest to add here that file names which match but for the letter
case will make trouble on DOS and Windows, even if long file names are
supported.