Re: [Patch]: Add descriptions to gdb/doc/gdbint.texinfo

[Eli Zaretskii <eliz at gnu dot org>]

> Date: Thu, 01 Feb 2007 10:26:32 +0100
> From: Markus Deuling <deuling@de.ibm.com>
> 
> this patch updates the descriptions of the elements in enum gdb_osabi and
> adds a description for function generic_elf_osabi_sniff_abi_tag_sections
> from osabi.h to GDB Internals.

Thanks.  I committed a slightly different patch, see below.

A few comments.

>         * gdbint.texinfo (Operation System ABI Variant
>         Handling): Update descriptions for new/deleted elements
>         in gdb_osabi. Add missing description for function
>         generic_elf_osabi_sniff_abi_tag_sections.

The part in the parens shouldn't be broken between two lines; see the
GNU Coding Standards for details.

> diff -urN src/gdb/doc/gdbint.texinfo dev/gdb/doc/gdbint.texinfo
> --- src/gdb/doc/gdbint.texinfo  2007-01-20 17:51:56.000000000 +0100
> +++ dev/gdb/doc/gdbint.texinfo  2007-02-01 10:13:12.000000000 +0100
> @@ -2615,10 +2615,14 @@
> selected OS ABI.  There may be only one handler for a given OS ABI
> for each BFD architecture.
> 
> -The following OS ABI variants are defined in @file{osabi.h}:
> +The following OS ABI variants are defined in @file{defs.h}:

Your email client removed leading blanks from unchanged lines, which
caused Patch to choke.  I needed to fix those lines manually.  Please
in the future use a less intrusive email client, or send the patches
as binary attachments.

> +@findex GDB_OSABI_INTERIX
> +@item GDB_OSABI_INTERIX
> +Irix.

Interix is not Irix, it's a Posix layer above MS-Windows.

> +Helper routine for ELF file sniffers. Examine the file described
                                       ^^
Two spaces after a period that ends a sentence.

Last, but not least: you don't have a copyright assignment on file in
the FSF records.  So, while I'm very grateful for your contributions,
I will be unable to accept any more patches for you until you sign the
legal papers required by the FSF, since you all but exhausted the
small number of changes granted by the FSF "tiny change" policy.

I urge you to sign the legal papers, so you could continue your
valuable contributions to GDB.

Here's the patch I actually committed:

Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.251
diff -u -r1.251 gdbint.texinfo
--- gdbint.texinfo	20 Jan 2007 16:51:56 -0000	1.251
+++ gdbint.texinfo	2 Feb 2007 19:47:59 -0000
@@ -2615,10 +2615,14 @@
 selected OS ABI.  There may be only one handler for a given OS ABI
 for each BFD architecture.
 
-The following OS ABI variants are defined in @file{osabi.h}:
+The following OS ABI variants are defined in @file{defs.h}:
 
 @table @code
 
+@findex GDB_OSABI_UNINITIALIZED
+@item GDB_OSABI_UNINITIALIZED
+Used for struct gdbarch_info if ABI is still uninitialized.
+
 @findex GDB_OSABI_UNKNOWN
 @item GDB_OSABI_UNKNOWN
 The ABI of the inferior is unknown.  The default @code{gdbarch}
@@ -2626,63 +2630,87 @@
 
 @findex GDB_OSABI_SVR4
 @item GDB_OSABI_SVR4
-UNIX System V Release 4
+UNIX System V Release 4.
 
 @findex GDB_OSABI_HURD
 @item GDB_OSABI_HURD
-GNU using the Hurd kernel
+GNU using the Hurd kernel.
 
 @findex GDB_OSABI_SOLARIS
 @item GDB_OSABI_SOLARIS
-Sun Solaris
+Sun Solaris.
 
 @findex GDB_OSABI_OSF1
 @item GDB_OSABI_OSF1
-OSF/1, including Digital UNIX and Compaq Tru64 UNIX
+OSF/1, including Digital UNIX and Compaq Tru64 UNIX.
 
 @findex GDB_OSABI_LINUX
 @item GDB_OSABI_LINUX
-GNU using the Linux kernel
+GNU using the Linux kernel.
 
 @findex GDB_OSABI_FREEBSD_AOUT
 @item GDB_OSABI_FREEBSD_AOUT
-FreeBSD using the a.out executable format
+FreeBSD using the @code{a.out} executable format.
 
 @findex GDB_OSABI_FREEBSD_ELF
 @item GDB_OSABI_FREEBSD_ELF
-FreeBSD using the ELF executable format
+FreeBSD using the ELF executable format.
 
 @findex GDB_OSABI_NETBSD_AOUT
 @item GDB_OSABI_NETBSD_AOUT
-NetBSD using the a.out executable format
+NetBSD using the @code{a.out} executable format.
 
 @findex GDB_OSABI_NETBSD_ELF
 @item GDB_OSABI_NETBSD_ELF
-NetBSD using the ELF executable format
+NetBSD using the ELF executable format.
+
+@findex GDB_OSABI_OPENBSD_ELF
+@item GDB_OSABI_OPENBSD_ELF
+OpenBSD using the ELF executable format.
 
 @findex GDB_OSABI_WINCE
 @item GDB_OSABI_WINCE
-Windows CE
+Windows CE.
 
 @findex GDB_OSABI_GO32
 @item GDB_OSABI_GO32
-DJGPP
+DJGPP.
 
 @findex GDB_OSABI_NETWARE
 @item GDB_OSABI_NETWARE
-Novell NetWare
+Novell NetWare.
 
-@findex GDB_OSABI_ARM_EABI_V1
-@item GDB_OSABI_ARM_EABI_V1
-ARM Embedded ABI version 1
-
-@findex GDB_OSABI_ARM_EABI_V2
-@item GDB_OSABI_ARM_EABI_V2
-ARM Embedded ABI version 2
-
-@findex GDB_OSABI_ARM_APCS
-@item GDB_OSABI_ARM_APCS
-Generic ARM Procedure Call Standard
+@findex GDB_OSABI_IRIX
+@item GDB_OSABI_IRIX
+Irix.
+
+@findex GDB_OSABI_LYNXOS
+@item GDB_OSABI_LYNXOS
+LynxOS.
+
+@findex GDB_OSABI_INTERIX
+@item GDB_OSABI_INTERIX
+Interix (Posix layer for MS-Windows systems).
+
+@findex GDB_OSABI_HPUX_ELF
+@item GDB_OSABI_HPUX_ELF
+HP/UX using the ELF executable format.
+
+@findex GDB_OSABI_HPUX_SOM
+@item GDB_OSABI_HPUX_SOM
+HP/UX using the SOM executable format.
+
+@findex GDB_OSABI_QNXNTO
+@item GDB_OSABI_QNXNTO
+QNX Neutrino.
+
+@findex GDB_OSABI_CYGWIN
+@item GDB_OSABI_CYGWIN
+Cygwin.
+
+@findex GDB_OSABI_AIX
+@item GDB_OSABI_AIX
+AIX.
 
 @end table
 
@@ -2722,6 +2750,13 @@
 with the defaults already established for @var{gdbarch}.
 @end deftypefun
 
+@deftypefun void generic_elf_osabi_sniff_abi_tag_sections (bfd *@var{abfd}, asection *@var{sect}, void *@var{obj})
+Helper routine for ELF file sniffers.  Examine the file described by
+@var{abfd} and look at ABI tag note sections to determine the OS ABI
+from the note.  This function should be called via
+@code{bfd_map_over_sections}.
+@end deftypefun
+
 @section Initializing a New Architecture
 
 Each @code{gdbarch} is associated with a single @sc{bfd} architecture,