This is the mail archive of the
gdb-patches@sourceware.org
mailing list for the GDB project.
Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1
- From: Eli Zaretskii <eliz at gnu dot org>
- To: Jan Kratochvil <jan dot kratochvil at redhat dot com>
- Cc: tromey at redhat dot com, gdb-patches at sourceware dot org
- Date: Fri, 05 Apr 2013 18:23:07 +0300
- Subject: Re: [patchv2+doc] New gdbinit.5 man page + converted gdb.1+gdbserver.1
- References: <87pq05mdqc dot fsf at fleche dot redhat dot com> <83lias3ybi dot fsf at gnu dot org> <20130219162741 dot GA4493 at host2 dot jankratochvil dot net> <838v6kp4gu dot fsf at gnu dot org> <20130220084353 dot GA801 at host2 dot jankratochvil dot net> <83fw0qokfw dot fsf at gnu dot org> <20130404160915 dot GA11966 at host2 dot jankratochvil dot net> <83sj36fcxb dot fsf at gnu dot org> <20130404171439 dot GA20464 at host2 dot jankratochvil dot net> <83obduf9ny dot fsf at gnu dot org> <20130405150101 dot GA15883 at host2 dot jankratochvil dot net>
- Reply-to: Eli Zaretskii <eliz at gnu dot org>
> Date: Fri, 5 Apr 2013 17:01:01 +0200
> From: Jan Kratochvil <jan.kratochvil@redhat.com>
> Cc: tromey@redhat.com, gdb-patches@sourceware.org
>
> On Thu, 04 Apr 2013 20:11:29 +0200, Eli Zaretskii wrote:
> > > +@c man begin SYNOPSIS gdb
> > > +gdb [@option{-help}] [@option{-nh}] [@option{-nx}] [@option{-q}]
> > > +[@option{-batch}] [@option{-cd=}@var{dir}] [@option{-f}]
> > > +[@option{-b}@w{ }@var{bps}]
> > > + [@option{-tty=}@var{dev}] [@option{-s} @var{symfile}]
> > > +[@option{-e}@w{ }@var{prog}] [@option{-se}@w{ }@var{prog}]
> > > +[@option{-c}@w{ }@var{core}] [@option{-x}@w{ }@var{cmds}]
> > > + [@option{-d}@w{ }@var{dir}] [@var{prog}|@var{core}|@var{procID}]
> > > +@c man end
> >
> > Why are the options formatted in such a strange way -- some lines
> > indented, others not? The original man page has them all aligned
> > nicely after formatting:
> >
> > SYNOPSIS
> > gdb [-help] [-nx] [-q] [-batch] [-cd=dir] [-f] [-b bps] [-tty=dev]
> > [-s symfile] [-e prog] [-se prog] [-c core] [-x file] [-ex cmd]
> > [-d dir] [prog[core|procID]]
>
> cd gdb/doc;make gdb.1;nroff -man gdb.1|less -r
> SYNOPSIS
> gdb [-help] [-nh] [-nx] [-q] [-batch] [-cd=dir] [-f] [-b bps]
> [-tty=dev] [-s symfile] [-e prog] [-se prog] [-c core] [-x cmds]
> [-d dir] [prog|core|procID]
>
> The formatting is kept for the man page but it looks weird in the .texinfo
> source. It is because I tried to keep the .texinfo source <= 80 columns,
> I believe you do not prefer an equivalent .texinfo form (174 columns):
No, of course not. But if you use @verbatim..@end verbatim around
this block, you can simply format the text exactly as you want it in
the produced formats, and makeinfo will not fill or reindent that
text.
> Sending FYI, I will check it in without further comments.
Please go ahead after using @verbatim as suggested above, this is fine
otherwise.
Thanks.