Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Mingjie Xing <mingjie.xing@gmail.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [patch] Share options between info and man page
Date: Tue, 10 Jun 2014 17:56:00 -0000	[thread overview]
Message-ID: <8338fc1wed.fsf@gnu.org> (raw)
In-Reply-To: <CADNgcEwweARHgsH5ppJEY=Q8UrtKK7xi8mU6BN7EbjUs=ic1xg@mail.gmail.com>

> From: Mingjie Xing <mingjie.xing@gmail.com>
> Date: Tue, 10 Jun 2014 15:00:12 +0800
> Cc: gdb-patches@sourceware.org
> 
> I made a compare and find that only one paragraph and one option are
> unique to man page:
> 
> "All the options and command line arguments you give are processed
> in sequential order.  The order makes a difference when the @option{-x}
> option is used."
> 
> and
> 
> "@item -help
> @itemx -h
> List all options, with brief explanations."
> 
> I've preserved them and moved to 'File Options'.
> 
> On the other hand, there are many options missing in man page which
> can be resolved by sharing.
> 
> >> For an example, gcc's man page and info page use the
> >> same file 'invoke.texi' which includes @node and @section lines.
> >
> > I'm sorry, but GCC's example is unlikely to convince me, because I
> > consider the GCC documentation to be one of the worst examples in the
> > GNU project.  I can never find useful up to date information there
> > when I'm looking for it.
> >
> > It should be easy to keep the @node and @chapter out of the man page.
> 
> Done.

Thanks.  This looks good to me.  If no one objects, it should go in
soon.


  parent reply	other threads:[~2014-06-10 17:56 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-09  8:40 Mingjie Xing
2014-06-09 14:52 ` Eli Zaretskii
2014-06-10  0:46   ` Mingjie Xing
2014-06-10  2:52     ` Eli Zaretskii
2014-06-10  7:00       ` Mingjie Xing
2014-06-10  7:03         ` Mingjie Xing
2014-06-10 17:56         ` Eli Zaretskii [this message]
2014-06-11 11:39           ` Pedro Alves
2014-06-12  3:36             ` Mingjie Xing
2014-06-23 13:45               ` Pedro Alves
2014-06-24  7:08                 ` Mingjie Xing
2014-06-24 15:56                   ` Eli Zaretskii
2014-06-25  1:30                     ` Mingjie Xing
2014-06-26  9:34                       ` Mingjie Xing
2014-07-07  1:12                         ` Mingjie Xing
2014-07-07 14:18                           ` Joel Brobecker
2014-07-07 15:26                             ` Eli Zaretskii
2014-07-07 15:31                               ` Joel Brobecker
2014-07-08  9:47                               ` Pedro Alves
2014-07-08 14:59                                 ` 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=8338fc1wed.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=mingjie.xing@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