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

On Wed, 13 Feb 2013 18:42:25 +0100, Eli Zaretskii wrote:
> I just don't see how it will make maintenance simpler.  But I'm
> prepared to be convinced ;-)

On Tue, 12 Feb 2013 17:11:18 +0100, Eli Zaretskii wrote:
> Why is this better than maintaining man pages in their roff format?

One reason is that mostly any other format is more convenient to write and
maintain than roff.  So that means to write man pages either in pod or in
texinfo (or maybe in some other format but not roff).

At least the content of man page for gdb/gdb_gcore.sh (/usr/bin/gcore) should
be available also in texinfo as gcore's script description is currently not
present in the GDB manual.

Having gdb/gdb_gcore.sh man page in texinfo and other (like /usr/bin/gdb) man
pages in other format seems more complicated to me than having all the man
pages in single format (which is texinfo in this case).

Another reason is that GDB contributors already have to know texinfo for the
GDB manual updates so it means a more difficult learning curve to require
another documentation format (such as pod) knowledge from contributors.

Is there some reason why not to have all the GDB man pages in texinfo?


Thanks,
Jan


  reply	other threads:[~2013-02-19 16:28 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 [this message]
2013-02-19 18:03           ` Eli Zaretskii
2013-02-20  8:44             ` Jan Kratochvil
2013-02-20 19:26               ` Eli Zaretskii
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=20130219162741.GA4493@host2.jankratochvil.net \
    --to=jan.kratochvil@redhat.com \
    --cc=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --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