Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Jan Kratochvil <jan.kratochvil@redhat.com>
Cc: tromey@redhat.com, gdb-patches@sourceware.org
Subject: Re: [patch+doc] New gdbinit.5 man page
Date: Wed, 20 Feb 2013 19:26:00 -0000	[thread overview]
Message-ID: <83fw0qokfw.fsf@gnu.org> (raw)
In-Reply-To: <20130220084353.GA801@host2.jankratochvil.net>

> 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.


  reply	other threads:[~2013-02-20 19:26 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-02-11 20:14 Jan Kratochvil
2013-02-12 16:11 ` Eli Zaretskii
2013-02-12 16:22   ` Jan Kratochvil
2013-02-12 21:20     ` Tom Tromey
2013-02-13 17:42       ` Eli Zaretskii
2013-02-19 16:28         ` Jan Kratochvil
2013-02-19 18:03           ` Eli Zaretskii
2013-02-20  8:44             ` Jan Kratochvil
2013-02-20 19:26               ` Eli Zaretskii [this message]
2013-04-04 22:09                 ` [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 Jan Kratochvil
2013-04-05 11:47                   ` Eli Zaretskii
2013-04-05 13:03                     ` Jan Kratochvil
2013-04-05 13:03                       ` Eli Zaretskii
2013-04-05 17:50                         ` Jan Kratochvil
2013-04-05 16:33                           ` Jan Kratochvil
2013-04-05 18:13                           ` [doc patch] gdb.1: Add -p PID Jan Kratochvil
2013-04-05 18:40                             ` Eli Zaretskii
2013-04-06  9:01                               ` [commit] " Jan Kratochvil
2013-04-05 18:29                           ` [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1 Eli Zaretskii
2013-04-05 19:06                             ` Jan Kratochvil
2013-04-05 19:43                               ` Eli Zaretskii
2013-04-06  6:47                                 ` Jan Kratochvil
2013-04-06  6:54                                   ` Eli Zaretskii
2013-04-06  8:45                                     ` [commit] " Jan Kratochvil

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=83fw0qokfw.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=jan.kratochvil@redhat.com \
    --cc=tromey@redhat.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