From: Eli Zaretskii <eliz@gnu.org>
To: Sergio Durigan Junior <sergiodj@redhat.com>
Cc: gdb-patches@sourceware.org, tom@tromey.com
Subject: Re: [PATCH] Install and generate docs for gdb-add-index
Date: Fri, 12 Jan 2018 18:39:00 -0000 [thread overview]
Message-ID: <837esm3os0.fsf@gnu.org> (raw)
In-Reply-To: <87lgh3au9s.fsf@redhat.com> (message from Sergio Durigan Junior on Fri, 12 Jan 2018 11:58:39 -0500)
> From: Sergio Durigan Junior <sergiodj@redhat.com>
> 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.
prev parent reply other threads:[~2018-01-12 18:39 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-11 21:35 Sergio Durigan Junior
2018-01-11 22:27 ` Simon Marchi
2018-01-12 4:18 ` Sergio Durigan Junior
2018-01-12 4:20 ` [PATCH v2] " Sergio Durigan Junior
2018-01-12 9:19 ` Eli Zaretskii
2018-01-12 12:44 ` Simon Marchi
2018-01-12 20:31 ` Sergio Durigan Junior
2018-01-12 8:34 ` [PATCH] " Eli Zaretskii
2018-01-12 16:58 ` Sergio Durigan Junior
2018-01-12 18:39 ` Eli Zaretskii [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=837esm3os0.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=sergiodj@redhat.com \
--cc=tom@tromey.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).