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: [RFA 3/3] NEWS and documentation for leading-args related concept and commands.


> From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> Cc: Philippe Waroquiers <philippe.waroquiers@skynet.be>
> Date: Tue, 25 Jun 2019 01:11:44 +0200
> 
> +* Command leading args::        Automatically prepend arguments to commands and aliases

The name of the section sounds too long to me.  How about this
instead:

  * Leading Arguments::            Leading arguments to commands

> +@node Command leading args
> +@section Automatically prepend arguments to commands and aliases

Likewise here.  Also, the section name should have its words
capitalized.

> +If you repetitively use the same arguments or options for a command,
          ^^^^^^^^^^^^
"repeatedly"

> +you can tell @value{GDBN} to automatically prepend these arguments
> +or options to the arguments you type explicitely.
                                        ^^^^^^^^^^^
"explicitly"

> +@code{set enable-leading-args off}.  The leading args of all commands are not cleared, but
> +will not be used till you do @code{set enable-leading-args on}.
                             ^^
"type", not "do".  Also, please use @kbd instead of @code for commands
the user is supposed to type.

> +arguments typed explicitely on the command line.
                   ^^^^^^^^^^^
"explicitly"

Finally, please refill the text so that each line is shorter than 79
columns, otherwise it's hard to read the Texinfo source.

Thanks.


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