From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 45614 invoked by alias); 27 Jul 2018 08:50:28 -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 45603 invoked by uid 89); 27 Jul 2018 08:50:27 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-24.9 required=5.0 tests=AWL,BAYES_00,GIT_PATCH_0,GIT_PATCH_1,GIT_PATCH_2,GIT_PATCH_3,SPF_PASS autolearn=ham version=3.3.2 spammy=indexcache, stabs, H*f:sk:1532558, index-cache 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, 27 Jul 2018 08:50:26 +0000 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fiyS3-00025T-Kn for gdb-patches@sourceware.org; Fri, 27 Jul 2018 04:50:24 -0400 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:42999) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fiyS3-00025M-Hz; Fri, 27 Jul 2018 04:50:19 -0400 Received: from [176.228.60.248] (port=1383 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1fiyS2-0006yS-Vo; Fri, 27 Jul 2018 04:50:19 -0400 Date: Fri, 27 Jul 2018 08:50:00 -0000 Message-Id: <83pnz9rrjo.fsf@gnu.org> From: Eli Zaretskii To: Simon Marchi CC: gdb-patches@sourceware.org In-reply-to: <1532558824-829-5-git-send-email-simon.marchi@ericsson.com> (message from Simon Marchi on Wed, 25 Jul 2018 18:47:04 -0400) Subject: Re: [PATCH v2 4/4] Add doc and news for DWARF index cache References: <1532558824-829-1-git-send-email-simon.marchi@ericsson.com> <1532558824-829-5-git-send-email-simon.marchi@ericsson.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-07/txt/msg00732.txt.bz2 > From: Simon Marchi > CC: Simon Marchi > Date: Wed, 25 Jul 2018 18:47:04 -0400 > > This patch adds doc and news for the feature introduced by the previous > patch. Thanks. > +* DWARF index cache: GDB can now automatically save indices DWARF symbols on "indices of DWARF symbols", I presume? > diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo > index b36a39b..9533c72 100644 > --- a/gdb/doc/gdb.texinfo > +++ b/gdb/doc/gdb.texinfo > @@ -20095,6 +20095,42 @@ There are currently some limitation on indices. They only work when > for DWARF debugging information, not stabs. And, they do not > currently work for programs using Ada. > > +@subsection Automatic symbol index cache > + > +It is possible for GDB to automatically save a copy of this index in a cache ^^^ @value{GDBN} > +on disk and retrieve it from there when loading the same binary in the future. > +This feature can be turned on with @command{set index-cache on}. The following @command is incorrect here, it's the markup for shell commands, like 'ls'. What you want is @kbd. > +@table @code > + > +@item set index-cache on > +@itemx set index-cache off > + > +Enable or disable the use of the symbol index cache. There should be no empty line between @item and the following description. > + > +@item set index-cache directory @var{directory} > +@itemx show index-cache directory > +Set/show the directory where index files will be saved. By default, the value > +@code{$XDG_CACHE_HOME/gdb} is used if the @code{XDG_CACHE_HOME} environment > +variable is defined. The value @code{$HOME/.cache/gdb} is used otherwise. Please don't use $FOO to mean an environment variable, that is a Unix shell convention. I suggest to rephrase: By default, the index is cached in the @file{gdb} subdirectory of the directory pointed to by the @env{XDG_CACHE_HOME} environment variable, if it is defined, else in the @file{.cache/gdb} subdirectory of your home directory. > +@item set index-cache format @var{format} > +@itemx show index-cache format > +Set/show the format in which index files are saved. @var{format} can be either > +@code{gdb} (the default) or @code{dwarf-5}. Note that @value{GDBN} is currently > +only able to read back files in the @code{gdb} format from the cache, so > +@code{dwarf-5} is not very useful. If 'dwarf-5' cannot be used, why are we documenting it, and why are we documenting/implementing this command in the first place? > +@item show index-cache stats > +Print the number of cache hits and misses for the index cache since the launch > +of @value{GDBN}. This begs the question: for which index cache will this show the statistics? For the one defined by the latest "set index-cache directory" command?