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] Share options between info and man page


> Ping.
> 
> 2014-06-26 17:34 GMT+08:00 Mingjie Xing <mingjie.xing@gmail.com>:
> > I'd like to put an updated patch for both gdb.texinfo and texi2pod.pl,
> > plus the new comparing result.
> >
> > etc/ChangeLog:
> >
> >         * texi2pod.pl (postprocess): Move command process for '@sc' to the
> >         front of '@dfn'.  Add a new command process for '@t{...}', just print
> >         the content.
> >
> > gdb/doc/ChangeLog:
> >
> >         * gdb.texinfo (Man Pages): Remove the content of man OPTIONS
> > gdb, add
> >         a cross reference to 'Invoking GDB'.
> >         (Invoking GDB): Share the option sub-sections with man OPTIONS
> > gdb,
> >         move the uniqe part of man here.  To display correrctly in man
> > page,
> >         change '@xref' after a comma to 'see @ref', and change '@table
> > @code'
> >         to '@table @env'.

This is a documentation patch, so best to attract the documentation
maintainer's attention by adding something like "DOCO" in the email
subject.

Also, I think I saw that your patch was missing context info (ie,
straight diff), making it really hard to review. My suggestion is
to work straight off the git repository, to commit the change,
and then to email the patch. "git send-email" is very handy in
that regard.

-- 
Joel


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