Re: [PATCH] [gdb/doc]: Updated manpages to be consistent with help

[Eli Zaretskii via Gdb-patches <gdb-patches@sourceware.org>]

> Date: Wed, 13 Oct 2021 10:04:09 -0300
> From: Bruno Larsen via Gdb-patches <gdb-patches@sourceware.org>
> 
> Updated manpages to be consistent with help information provided by the
> binary. The main changes are Making all long-form options have '--',
> instead of a single '-' and added most of the missing options to the
> manpage.

Thanks.  The replacement of '-' by '--' are mechanical and don't need
any approval.

Many other changes replace something like this:

  Use @file{file} as SOMETHING.

with something like this:

  Use file @file{somefile} as SOMETHING.

I must confess that I prefer the former form, because it makes the
text more concise and easier to read, by avoiding one more "file".

> -@item -nh
> +@item --directory=@var{DIR}
> +@itemx -d @var{DIR}
> +Add @var{DIR} to the path to search for source files.

The string inside @var{..} should never be upper-case.  (Yes, I know
this was in the original text.)

Also, here I'd prefer

   Add @var{directory} to the path to search for source files.

because "DIR" doesn't necessarily speak for its being a directory.

> -@item -cd=@var{directory}
> -Run @value{GDBN} using @var{directory} as its working directory,
> +@item --batch-silent
> +Run in batch mode, just like @option{--batch}, but totally silent. All @value{GDBN}
> +output is supressed (stderr is unaffected). This is much quieter than
                                             ^^
Two spaces between sentences, please.

> +This is particularly useful when using targets that give 'Loading section'
                                                            ^^^^^^^^^^^^^^^^^
This should be in @samp, not in literal quotes.

> +Note that targets that give their ourpur via GDB, as opposed to writting
                                                ^^^
@value{GDBN}

> +directly to stdout, will also be made silent.

"stdout" should be in @code.  Or use "standard output" instead.

> +@item --args @var{prog} [@var{arglist}]
> +Change interpretation of command line so that arguments following this
> +option are passed as arguments to the inferior. As an example, take
                                                 ^^
Two spaces.

> +Will start GDB with @option{-q}, not printing the introductory message. On
              ^^^                                                        ^^
@value{GDBN}, and two spaces.

> +Starts GDB with the introductory message, and passes the option to the inferior.

@value{GDBN}

> +@item --pid=@var{PID}
> +Attach GDB to an already running program, with the PID @var{PID}.

Likewise.  Also, @var{PID} should be @var{pid}.

> +@item --configuration
> +Prints details about GDB configuration and then exit.

@value{GDBN}

> +@item --cd=@var{DIR}
> +Run @value{GDBN} using @var{DIR} as its working directory,
>  instead of the current directory.

Please replace "DIR" with "directory".

> -@item -fullname
> +@item --data-directory=@var{DIR}
> +@item -D
> +Run @value{GDBN} using @var{DIR} as its data directory. The data
> +directory is where @value{GDBN} searches for its auxiliary files.

Likewise.

> -@item -b @var{bps}
> +@item -b @var{BAUDRATE}

Uppercase @var again.

> -@item -tty=@var{device}
> +@item -l @var{TIMEOUT}
> +Set timeout, in seconds, for remote debugging.

And here.

Thanks.