Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Doug Evans <xdje42@gmail.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [doc RFA] Move docs on auto-loading extensions to Extending GDB section
Date: Mon, 23 Dec 2013 17:28:00 -0000	[thread overview]
Message-ID: <83wqiv79zw.fsf@gnu.org> (raw)
In-Reply-To: <m3eh53trti.fsf@sspiff.org>

> From: Doug Evans <xdje42@gmail.com>
> Date: Mon, 23 Dec 2013 09:12:09 -0800
> 
> This patch is in part a cleanup, and in part sets things up so that
> it's easier to add the corresponding docs for Guile scripting.

If it just moves stuff around without changing any actual content
(menus don't count), then it doesn't need to be reviewed, once we
agree on the restructuring itself (which is fine with me).

I have a couple of comments, which are probably to the text that was
already in the manual (so it is up to you whether to fix them):

> +@file{@var{OBJFILE}-gdb.@var{EXT}} and the @code{.debug_gdb_scripts}

Please don't use upper case in @var, it looks ugly in print.

> +section of modern file formats like @samp{ELF}.

"ELF" is not a programming language symbol, so doesn't need @samp.
Use either @acronym{ELF} or @sc{elf} or just ELF with no markup.

> +@menu
> +* objfile-gdb.ext file::         The @file{@var{objfile}-gdb.@var{ext}} file

Node names cannot contain periods, this confuses some Info readers.

> +For @value{GDBN} command files @xref{Auto-loading sequences}.
> +For Python files @xref{Python Auto-loading}.

@xref is inappropriate in the middle of a sentence, because it
produces a capitalized "Note".  Use @pxref or "see @ref" instead.

> +For systems using file formats like ELF and COFF,
> +when @value{GDBN} loads a new object file
> +it will look for a special section named @code{.debug_gdb_scripts}.
> +If this section exists, its contents is a list of NUL-terminated names
                                                     ^^^
"NULL", right?

Thanks.


  reply	other threads:[~2013-12-23 17:28 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-12-23 17:12 Doug Evans
2013-12-23 17:28 ` Eli Zaretskii [this message]
2013-12-23 18:04   ` Doug Evans
2013-12-23 18:45     ` Eli Zaretskii

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=83wqiv79zw.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=xdje42@gmail.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