From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 23759 invoked by alias); 4 Jun 2009 12:39:12 -0000 Received: (qmail 23749 invoked by uid 22791); 4 Jun 2009 12:39:11 -0000 X-SWARE-Spam-Status: No, hits=-1.7 required=5.0 tests=AWL,BAYES_00,MSGID_FROM_MTA_HEADER,SPF_PASS X-Spam-Check-By: sourceware.org Received: from mtagate8.de.ibm.com (HELO mtagate8.de.ibm.com) (195.212.29.157) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Thu, 04 Jun 2009 12:39:05 +0000 Received: from d12nrmr1607.megacenter.de.ibm.com (d12nrmr1607.megacenter.de.ibm.com [9.149.167.49]) by mtagate8.de.ibm.com (8.14.3/8.13.8) with ESMTP id n54CcYR4428738 for ; Thu, 4 Jun 2009 12:38:35 GMT Received: from d12av02.megacenter.de.ibm.com (d12av02.megacenter.de.ibm.com [9.149.165.228]) by d12nrmr1607.megacenter.de.ibm.com (8.13.8/8.13.8/NCO v9.2) with ESMTP id n54CcYLd2506902 for ; Thu, 4 Jun 2009 14:38:34 +0200 Received: from d12av02.megacenter.de.ibm.com (loopback [127.0.0.1]) by d12av02.megacenter.de.ibm.com (8.12.11.20060308/8.13.3) with ESMTP id n54CcYr8008669 for ; Thu, 4 Jun 2009 14:38:34 +0200 Received: from tuxmaker.boeblingen.de.ibm.com (tuxmaker.boeblingen.de.ibm.com [9.152.85.9]) by d12av02.megacenter.de.ibm.com (8.12.11.20060308/8.12.11) with SMTP id n54CcXji008648 for ; Thu, 4 Jun 2009 14:38:33 +0200 Message-Id: <200906041238.n54CcXji008648@d12av02.megacenter.de.ibm.com> Received: by tuxmaker.boeblingen.de.ibm.com (sSMTP sendmail emulation); Thu, 04 Jun 2009 14:38:33 +0200 Subject: [rfa/doc] Do not use formal parameters named "current_gdbarch" in the docs To: gdb-patches@sourceware.org Date: Thu, 04 Jun 2009 12:39:00 -0000 From: "Ulrich Weigand" MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org X-SW-Source: 2009-06/txt/msg00066.txt.bz2 Hello, gdbint.texinfo contains a number of cases where the struct gdbarch * formal parameter of a gdbarch callback function is shown with the name "current_gdbarch". This is somewhat confusing, as the sources never do that (and for good reason, because it would shadow the current_gdbarch global variable). In addition, this causes some false positives when grepping the sources for current_gdbarch instances that are to be eliminated. The following patch renames those formal paramters to "gdbarch", as is common usage in GDB source code. OK to apply? Bye, Ulrich ChangeLog: * gdbint.texinfo: Rename formal parameters to gdbarch function protoypes from "current_gdbarch" to "gdbarch". Index: gdb-head/gdb/doc/gdbint.texinfo =================================================================== --- gdb-head.orig/gdb/doc/gdbint.texinfo +++ gdb-head/gdb/doc/gdbint.texinfo @@ -3313,7 +3313,7 @@ relationship between pointers and addres definitions, appropriate for architectures on which all pointers are simple unsigned byte addresses. -@deftypefun CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *@var{current_gdbarch}, struct type *@var{type}, char *@var{buf}) +@deftypefun CORE_ADDR gdbarch_pointer_to_address (struct gdbarch *@var{gdbarch}, struct type *@var{type}, char *@var{buf}) Assume that @var{buf} holds a pointer of type @var{type}, in the appropriate format for the current architecture. Return the byte address the pointer refers to. @@ -3322,7 +3322,7 @@ This function may safely assume that @va C@t{++} reference type. @end deftypefun -@deftypefun void gdbarch_address_to_pointer (struct gdbarch *@var{current_gdbarch}, struct type *@var{type}, char *@var{buf}, CORE_ADDR @var{addr}) +@deftypefun void gdbarch_address_to_pointer (struct gdbarch *@var{gdbarch}, struct type *@var{type}, char *@var{buf}, CORE_ADDR @var{addr}) Store in @var{buf} a pointer of type @var{type} representing the address @var{addr}, in the appropriate format for the current architecture. @@ -3346,18 +3346,18 @@ following macros should be defined in or types within @value{GDBN} as well as provide the added information to a @value{GDBN} user when printing type expressions. -@deftypefun int gdbarch_address_class_type_flags (struct gdbarch *@var{current_gdbarch}, int @var{byte_size}, int @var{dwarf2_addr_class}) +@deftypefun int gdbarch_address_class_type_flags (struct gdbarch *@var{gdbarch}, int @var{byte_size}, int @var{dwarf2_addr_class}) Returns the type flags needed to construct a pointer type whose size is @var{byte_size} and whose address class is @var{dwarf2_addr_class}. This function is normally called from within a symbol reader. See @file{dwarf2read.c}. @end deftypefun -@deftypefun {char *} gdbarch_address_class_type_flags_to_name (struct gdbarch *@var{current_gdbarch}, int @var{type_flags}) +@deftypefun {char *} gdbarch_address_class_type_flags_to_name (struct gdbarch *@var{gdbarch}, int @var{type_flags}) Given the type flags representing an address class qualifier, return its name. @end deftypefun -@deftypefun int gdbarch_address_class_name_to_type_flags (struct gdbarch *@var{current_gdbarch}, int @var{name}, int *@var{type_flags_ptr}) +@deftypefun int gdbarch_address_class_name_to_type_flags (struct gdbarch *@var{gdbarch}, int @var{name}, int *@var{type_flags_ptr}) Given an address qualifier name, set the @code{int} referenced by @var{type_flags_ptr} to the type flags for that address class qualifier. @end deftypefun -- Dr. Ulrich Weigand GNU Toolchain for Linux on System z and Cell BE Ulrich.Weigand@de.ibm.com