From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 103495 invoked by alias); 12 Jan 2018 18:39:56 -0000 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 Received: (qmail 103485 invoked by uid 89); 12 Jan 2018 18:39:56 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-7.0 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_1,SPF_PASS,T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 spammy=sk:gdb-pat, sk:gdbpat, U*gdb-patches, gdbpatchessourcewareorg X-HELO: eggs.gnu.org Received: from eggs.gnu.org (HELO eggs.gnu.org) (208.118.235.92) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Fri, 12 Jan 2018 18:39:54 +0000 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ea4F2-0001iB-BE for gdb-patches@sourceware.org; Fri, 12 Jan 2018 13:39:53 -0500 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:58667) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ea4El-0001UU-Aa; Fri, 12 Jan 2018 13:39:31 -0500 Received: from [176.228.60.248] (port=4227 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1ea4Ek-0003UB-Px; Fri, 12 Jan 2018 13:39:31 -0500 Date: Fri, 12 Jan 2018 18:39:00 -0000 Message-Id: <837esm3os0.fsf@gnu.org> From: Eli Zaretskii To: Sergio Durigan Junior CC: gdb-patches@sourceware.org, tom@tromey.com In-reply-to: <87lgh3au9s.fsf@redhat.com> (message from Sergio Durigan Junior on Fri, 12 Jan 2018 11:58:39 -0500) Subject: Re: [PATCH] Install and generate docs for gdb-add-index Reply-to: Eli Zaretskii References: <20180111213530.23774-1-sergiodj@redhat.com> <83vag7329f.fsf@gnu.org> <87lgh3au9s.fsf@redhat.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2001:4830:134:3::e X-IsSubscribed: yes X-SW-Source: 2018-01/txt/msg00248.txt.bz2 > From: Sergio Durigan Junior > Cc: gdb-patches@sourceware.org, tom@tromey.com > Date: Fri, 12 Jan 2018 11:58:39 -0500 > > >> +@code{.gdb_index}. Note that the index is never generated for files that do > > ^^^^^^^^^^^^^^^^^ > > File names should have the @file markup. > > This refers to a section name, not a file name. Should it still be > marked as @file? No, it's my bad. @code is fine. > >> +not contain DWARF debug information (sections named @code{.debug_*}). > > > > I think this sentence is too obscure. I think we should say > > explicitly that the index can only be produced on systems which use > > ELF binaries and DWARF debug info. E.g., users of GDB on MS-Windows > > should understand from this that they cannot use this feature. > > Here's how I've rewritten this part: > > To determine whether a file contains such an index, use the command > @kbd{readelf -S filename}: the index is stored in a section named > @code{.gdb_index}. The index file can only be produced on systems > which use ELF binaries and DWARF debug information (i.e., sections > named @code{.debug_*}). Looks good, thanks.