This is the mail archive of the gdb-patches@sourceware.org mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [patch+doc] New gdbinit.5 man page


> Date: Wed, 20 Feb 2013 09:43:53 +0100
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: tromey@redhat.com, gdb-patches@sourceware.org
> 
> +@node gdbinit man,,,Man Pages

There's no need to have prev/next/up pointers on the @node line, I
don't think we use them elsewhere.

> +@c man begin DESCRIPTION gdbinit
> +These files contain @value{GDBN} commands to automatically execute during
> +@value{GDBN} startup.  The lines of contents are canned sequences of commands,
> +described in the @value{GDBN} manual in node @code{Sequences}, accessible by
> +shell command @code{info -f gdb -n Sequences}.

Hmm.  A reference such as "in node @code{Sequences}" is not a Texinfo
reference, it won't produce a link that can be followed in an Info
reader.  If we want this stuff to be part of the manual, we could use
conditionals, so that we get a usual xref in the manual, and text like
above in the man pages.

Alternatively, we could keep these as separate files, not included in
the manual; then the form you used would be fine.

> +See more in the @value{GDBN} manual in node @code{Init File in the Current
> +Directory} - shell command
             ^^^
You want 2 or 3 dashes in a row here.

OK with those changes.

Thanks.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]