Re: [RFA 3/3] NEWS and documentation for / (slash) command.

Philippe Waroquiers
2019-04-13T19:22:25Z

Thanks for the review and the (as usual) good
suggestions/comments.
I will handle them for the next version.

Note that (if not done yet), it might be good
to check the on-line 'help /' doc which is in the top.c file
(see [RFA 1/3]).

Thanks

Philippe

On Sat, 2019-04-13 at 22:10 +0300, Eli Zaretskii wrote:
> > From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> > Cc: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> > Date: Sat, 13 Apr 2019 21:00:16 +0200
> >
> > +* New commands
> > +
> > +/SETTING... COMMAND
> > + The / command temporarily changes some settings according to SETTING
> > + to run COMMAND.
>
> ^^^^^^^^^^^^^^
> I'd say "for the duration of COMMAND" instead.
>
> > +@cindex Settings
> > +@cindex Temporarily change settings
>
> By convention, index entries are not capitalized, to avoid problems
> with sorting them alphabetically (which produces locale-dependent
> results).
>
> > +The following table gives the list of settings that the @code{/} command
> > +can temporarily change. The first column gives the letter sequence
> > +identifying the setting corresponding to the command in the second column.
> > +The third column gives the type of the setting, and list the different
> > +possible values for the enumeration settings. Note that the below table
> > +is produced by the @code{help /} command.
> > +
> > +@smallexample
> > +@c In the 'doc' build directory, the following can be produced by:
> > +@c ../../gdb/gdb -q --nx -ex 'set width 80' -ex 'set height 0' -ex 'help /' -ex quit |
> > +@c sed -e '1,/The temporarily changeable settings are:/d' -e ':a;s/^\( *\) /@\1/;ta' -e 's/^/@exdent /'
> > +@c Maybe this could/should be automated by the doc Makefile ?
> > +@exdent /Be set backtrace past-entry Boolean on|off
> > +@exdent /Bl set backtrace limit Unsigned integer (0 means unlimited)
>
> Please rewrite this as a @multitable, so that it looks good in all
> formats.
>
> Thanks.