This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [patch] Share options between info and man page
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Mingjie Xing <mingjie dot xing at gmail dot com>
- Cc: gdb-patches at sourceware dot org
- Date: Tue, 10 Jun 2014 20:56:10 +0300
- Subject: Re: [patch] Share options between info and man page
- Authentication-results: sourceware.org; auth=none
- References: <CADNgcEyi=PBbjzgK3MA=FM8QjWXz_jv-KuXYe5b4-pu+LUY6xA at mail dot gmail dot com> <831tuy2kzi dot fsf at gnu dot org> <CADNgcExfk1A=EWKGDD4dPD0E0+H5=_a+ssV1qV4-xzXO3OSDyg at mail dot gmail dot com> <83ioo91nnk dot fsf at gnu dot org> <CADNgcEwweARHgsH5ppJEY=Q8UrtKK7xi8mU6BN7EbjUs=ic1xg at mail dot gmail dot com>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> 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.