This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [doc RFA] Move docs on auto-loading extensions to Extending GDB section
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Doug Evans <xdje42 at gmail dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Mon, 23 Dec 2013 19:28:03 +0200
- Subject: Re: [doc RFA] Move docs on auto-loading extensions to Extending GDB section
- Authentication-results: sourceware.org; auth=none
- References: <m3eh53trti dot fsf at sspiff dot org>
- Reply-to: Eli Zaretskii <eliz at gnu dot 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.