From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 21089 invoked by alias); 20 Apr 2011 15:42:51 -0000 Received: (qmail 21076 invoked by uid 22791); 20 Apr 2011 15:42:50 -0000 X-SWARE-Spam-Status: No, hits=-0.9 required=5.0 tests=AWL,BAYES_00,SPF_SOFTFAIL X-Spam-Check-By: sourceware.org Received: from mtaout20.012.net.il (HELO mtaout20.012.net.il) (80.179.55.166) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Wed, 20 Apr 2011 15:42:32 +0000 Received: from conversion-daemon.a-mtaout20.012.net.il by a-mtaout20.012.net.il (HyperSendmail v2007.08) id <0LJY00A00IY2AN00@a-mtaout20.012.net.il> for gdb-patches@sourceware.org; Wed, 20 Apr 2011 18:41:51 +0300 (IDT) Received: from HOME-C4E4A596F7 ([77.124.129.240]) by a-mtaout20.012.net.il (HyperSendmail v2007.08) with ESMTPA id <0LJY0089LJLNZEK0@a-mtaout20.012.net.il>; Wed, 20 Apr 2011 18:41:49 +0300 (IDT) Date: Wed, 20 Apr 2011 15:42:00 -0000 From: Eli Zaretskii Subject: Re: RFA: add .gdb_index documentation to gdb.texinfo In-reply-to: To: Tom Tromey Cc: gdb-patches@sourceware.org, mjw@redhat.com Reply-to: Eli Zaretskii Message-id: <83y6352ako.fsf@gnu.org> References: X-IsSubscribed: yes 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: 2011-04/txt/msg00359.txt.bz2 > From: Tom Tromey > CC: Mark Wielaard > Date: Wed, 20 Apr 2011 07:59:22 -0600 > > This patch moves the documentation from a comment in dwarf2read.c to the > manual. Thanks! > +@node Index Section Format > +@appendix .gdb_index section format ".gdb_index" should be in @code in the @appendix line. > +@cindex .gdb_index section format I would also add another @cindex entry, "index section format". > +The section documents the index section that is created by @code{save ^^^^^^^^^^^ You probably meant "This section" here. > +@code{offset_type}. Big endian machines must byte-swap the values > +before using them. Exceptions to this rule are noted. The data is ^^ Two spaces, please. > +A string in the constant pool is @samp{\0}-terminated. I think "zero-terminated" is better. > +The hash value for a table entry is computed by an applying an ^^ Remove that extra "an". > +The step size used in the hash table is computed via > +@code{((hash * 17) & (size - 1)) | 1}, where @samp{hash} is the hash > +value, and @samp{size} is the size of the hash table. It's unclear from the text when is this "step size" used. Perhaps say a word or two about that. > +The names of C@t{++} symbols in the hash table are canonicalized. We > +don't currently have a simple description of the canonicalization > +algorithm; if you intend to create new index sections, you must read > +the code. > + > +A CU vector in the constant pool is a sequence of @code{offset_type} > +values. The first value is the number of CU indices in the vector. > +Each subsequent value is the index of a CU in the CU list. This > +element in the hash table is used to indicate which CUs define the > +symbol. The text of this @item interleaves information about the hash table proper with info about the constant pool, which is actually described in the next @item. Perhaps it would be good to have all the info about the constant pool in the next item of the enumerated list? Thanks.