Fix whitespace in "help set inferior-tty"

  Hi,

I've noticed that doc strings of "set inferior-tty" and "set cwd" have
some excess whitespace, which makes them display with unexpected
indentation, at least in a Windows command prompt window.  The patch
below fixes that.  OK to install?

gdb/infcmd.c (_initialize_infcmd): Remove excess whitespace.
  

On 2024-04-16 10:48, Eli Zaretskii wrote:
> Hi,
> 
> I've noticed that doc strings of "set inferior-tty" and "set cwd" have
> some excess whitespace, which makes them display with unexpected
> indentation, at least in a Windows command prompt window.  The patch
> below fixes that.  OK to install?

I see the same problem.

grepping around, I think I found more instances of the same problem:

linux-nat.c:4704:Set debugging of GNU/Linux native target."), _("       \
linux-nat.c:4705:Show debugging of GNU/Linux native target."), _("      \
riscv-tdep.c:4824:Set debugger's use of compressed breakpoints."), _("  \
top.c:2270:Set whether GDB should start up quietly."), _("              \

Can you confirm and include them in your patch?

Simon
  

> Date: Tue, 16 Apr 2024 11:45:06 -0400
> From: Simon Marchi <simark@simark.ca>
> 
> 
> 
> On 2024-04-16 10:48, Eli Zaretskii wrote:
> > Hi,
> > 
> > I've noticed that doc strings of "set inferior-tty" and "set cwd" have
> > some excess whitespace, which makes them display with unexpected
> > indentation, at least in a Windows command prompt window.  The patch
> > below fixes that.  OK to install?
> 
> I see the same problem.
> 
> grepping around, I think I found more instances of the same problem:
> 
> linux-nat.c:4704:Set debugging of GNU/Linux native target."), _("       \
> linux-nat.c:4705:Show debugging of GNU/Linux native target."), _("      \
> riscv-tdep.c:4824:Set debugger's use of compressed breakpoints."), _("  \
> top.c:2270:Set whether GDB should start up quietly."), _("              \
> 
> Can you confirm and include them in your patch?

Confirmed and installed as below.  Thanks.

commit 6a2dbb742dc5aa18bc7995f7af55fb6e74c3ae4a
Author:     Eli Zaretskii <eliz@gnu.org>
AuthorDate: Tue Apr 16 19:13:39 2024 +0300
Commit:     Eli Zaretskii <eliz@gnu.org>
CommitDate: Tue Apr 16 19:13:39 2024 +0300

    Remove excess whitespace from doc strings of some commands
    
    I've noticed that doc strings of some commands, like "set cwd"
    and  "set inferior-tty", have some excess whitespace, which
    makes them display with unexpected indentation, at least in a
    Windows command prompt window.  This patch fixes that.
    
    * gdb/linux-nat.c (_initialize_linux_nat):
    * gdb/riscv-tdep.c (riscv_insn):
    * gdb/top.c (quit_force):
    * gdb/infcmd.c (_initialize_infcmd): Remove excess whitespace.

diff --git a/gdb/infcmd.c b/gdb/infcmd.c
index 600c90c..10a964a 100644
--- a/gdb/infcmd.c
+++ b/gdb/infcmd.c
@@ -3093,10 +3093,10 @@ _initialize_infcmd ()
   /* Add the filename of the terminal connected to inferior I/O.  */
   auto tty_set_show
     = add_setshow_optional_filename_cmd ("inferior-tty", class_run, _("\
-Set terminal for future runs of program being debugged."), _("		\
-Show terminal for future runs of program being debugged."), _("		\
-Usage: set inferior-tty [TTY]\n\n					\
-If TTY is omitted, the default behavior of using the same terminal as GDB\n \
+Set terminal for future runs of program being debugged."), _("\
+Show terminal for future runs of program being debugged."), _("\
+Usage: set inferior-tty [TTY]\n\n\
+If TTY is omitted, the default behavior of using the same terminal as GDB\n\
 is restored."),
 					 set_tty_value,
 					 get_tty_value,
@@ -3117,8 +3117,8 @@ Follow this command with any number of args, to be passed to the program."),
 
   auto cwd_set_show
     = add_setshow_string_noescape_cmd ("cwd", class_run, _("\
-Set the current working directory to be used when the inferior is started.\n \
-Changing this setting does not have any effect on inferiors that are\n	\
+Set the current working directory to be used when the inferior is started.\n\
+Changing this setting does not have any effect on inferiors that are\n\
 already running."),
 				       _("\
 Show the current working directory that is used when the inferior is started."),
diff --git a/gdb/linux-nat.c b/gdb/linux-nat.c
index 2602e1f..42051f2 100644
--- a/gdb/linux-nat.c
+++ b/gdb/linux-nat.c
@@ -4701,8 +4701,8 @@ _initialize_linux_nat ()
 {
   add_setshow_boolean_cmd ("linux-nat", class_maintenance,
 			   &debug_linux_nat, _("\
-Set debugging of GNU/Linux native target."), _("	\
-Show debugging of GNU/Linux native target."), _("	\
+Set debugging of GNU/Linux native target."), _("\
+Show debugging of GNU/Linux native target."), _("\
 When on, print debug messages relating to the GNU/Linux native target."),
 			   nullptr,
 			   show_debug_linux_nat,
diff --git a/gdb/riscv-tdep.c b/gdb/riscv-tdep.c
index f86a379..fe4da1a 100644
--- a/gdb/riscv-tdep.c
+++ b/gdb/riscv-tdep.c
@@ -4821,7 +4821,7 @@ initialisation process."),
   add_setshow_auto_boolean_cmd ("use-compressed-breakpoints", no_class,
 				&use_compressed_breakpoints,
 				_("\
-Set debugger's use of compressed breakpoints."), _("	\
+Set debugger's use of compressed breakpoints."), _("\
 Show debugger's use of compressed breakpoints."), _("\
 Debugging compressed code requires compressed breakpoints to be used. If\n\
 left to 'auto' then gdb will use them if the existing instruction is a\n\
diff --git a/gdb/top.c b/gdb/top.c
index 6e9df41..d01a0c2 100644
--- a/gdb/top.c
+++ b/gdb/top.c
@@ -2267,7 +2267,7 @@ input settings."),
 
   add_setshow_boolean_cmd ("startup-quietly", class_support,
 			       &startup_quiet, _("\
-Set whether GDB should start up quietly."), _("		\
+Set whether GDB should start up quietly."), _("\
 Show whether GDB should start up quietly."), _("\
 This setting will not affect the current session.  Instead this command\n\
 should be added to the .gdbearlyinit file in the users home directory to\n\
  

Note that gdb/unittests/command-def-selftests.c checks various invariants about the
command doc strings.
We might add there a new invariant that there is no white space before a LF
and no space at the end of doc string.

This should avoid such problems to re-appear in the future.

Thanks

Philippe


On Tue, 2024-04-16 at 19:16 +0300, Eli Zaretskii wrote:
> > Date: Tue, 16 Apr 2024 11:45:06 -0400
> > From: Simon Marchi <simark@simark.ca>
> > 
> > 
> > 
> > On 2024-04-16 10:48, Eli Zaretskii wrote:
> > > Hi,
> > > 
> > > I've noticed that doc strings of "set inferior-tty" and "set cwd" have
> > > some excess whitespace, which makes them display with unexpected
> > > indentation, at least in a Windows command prompt window.  The patch
> > > below fixes that.  OK to install?
> > 
> > I see the same problem.
> > 
> > grepping around, I think I found more instances of the same problem:
> > 
> > linux-nat.c:4704:Set debugging of GNU/Linux native target."), _("       \
> > linux-nat.c:4705:Show debugging of GNU/Linux native target."), _("      \
> > riscv-tdep.c:4824:Set debugger's use of compressed breakpoints."), _("  \
> > top.c:2270:Set whether GDB should start up quietly."), _("              \
> > 
> > Can you confirm and include them in your patch?
> 
> Confirmed and installed as below.  Thanks.
> 
> commit 6a2dbb742dc5aa18bc7995f7af55fb6e74c3ae4a
> Author:     Eli Zaretskii <eliz@gnu.org>
> AuthorDate: Tue Apr 16 19:13:39 2024 +0300
> Commit:     Eli Zaretskii <eliz@gnu.org>
> CommitDate: Tue Apr 16 19:13:39 2024 +0300
> 
>     Remove excess whitespace from doc strings of some commands
>     
>     I've noticed that doc strings of some commands, like "set cwd"
>     and  "set inferior-tty", have some excess whitespace, which
>     makes them display with unexpected indentation, at least in a
>     Windows command prompt window.  This patch fixes that.
>     
>     * gdb/linux-nat.c (_initialize_linux_nat):
>     * gdb/riscv-tdep.c (riscv_insn):
>     * gdb/top.c (quit_force):
>     * gdb/infcmd.c (_initialize_infcmd): Remove excess whitespace.
> 
> diff --git a/gdb/infcmd.c b/gdb/infcmd.c
> index 600c90c..10a964a 100644
> --- a/gdb/infcmd.c
> +++ b/gdb/infcmd.c
> @@ -3093,10 +3093,10 @@ _initialize_infcmd ()
>    /* Add the filename of the terminal connected to inferior I/O.  */
>    auto tty_set_show
>      = add_setshow_optional_filename_cmd ("inferior-tty", class_run, _("\
> -Set terminal for future runs of program being debugged."), _("		\
> -Show terminal for future runs of program being debugged."), _("		\
> -Usage: set inferior-tty [TTY]\n\n					\
> -If TTY is omitted, the default behavior of using the same terminal as GDB\n \
> +Set terminal for future runs of program being debugged."), _("\
> +Show terminal for future runs of program being debugged."), _("\
> +Usage: set inferior-tty [TTY]\n\n\
> +If TTY is omitted, the default behavior of using the same terminal as GDB\n\
>  is restored."),
>  					 set_tty_value,
>  					 get_tty_value,
> @@ -3117,8 +3117,8 @@ Follow this command with any number of args, to be passed to the
> program."),
>  
>    auto cwd_set_show
>      = add_setshow_string_noescape_cmd ("cwd", class_run, _("\
> -Set the current working directory to be used when the inferior is started.\n \
> -Changing this setting does not have any effect on inferiors that are\n	\
> +Set the current working directory to be used when the inferior is started.\n\
> +Changing this setting does not have any effect on inferiors that are\n\
>  already running."),
>  				       _("\
>  Show the current working directory that is used when the inferior is started."),
> diff --git a/gdb/linux-nat.c b/gdb/linux-nat.c
> index 2602e1f..42051f2 100644
> --- a/gdb/linux-nat.c
> +++ b/gdb/linux-nat.c
> @@ -4701,8 +4701,8 @@ _initialize_linux_nat ()
>  {
>    add_setshow_boolean_cmd ("linux-nat", class_maintenance,
>  			   &debug_linux_nat, _("\
> -Set debugging of GNU/Linux native target."), _("	\
> -Show debugging of GNU/Linux native target."), _("	\
> +Set debugging of GNU/Linux native target."), _("\
> +Show debugging of GNU/Linux native target."), _("\
>  When on, print debug messages relating to the GNU/Linux native target."),
>  			   nullptr,
>  			   show_debug_linux_nat,
> diff --git a/gdb/riscv-tdep.c b/gdb/riscv-tdep.c
> index f86a379..fe4da1a 100644
> --- a/gdb/riscv-tdep.c
> +++ b/gdb/riscv-tdep.c
> @@ -4821,7 +4821,7 @@ initialisation process."),
>    add_setshow_auto_boolean_cmd ("use-compressed-breakpoints", no_class,
>  				&use_compressed_breakpoints,
>  				_("\
> -Set debugger's use of compressed breakpoints."), _("	\
> +Set debugger's use of compressed breakpoints."), _("\
>  Show debugger's use of compressed breakpoints."), _("\
>  Debugging compressed code requires compressed breakpoints to be used. If\n\
>  left to 'auto' then gdb will use them if the existing instruction is a\n\
> diff --git a/gdb/top.c b/gdb/top.c
> index 6e9df41..d01a0c2 100644
> --- a/gdb/top.c
> +++ b/gdb/top.c
> @@ -2267,7 +2267,7 @@ input settings."),
>  
>    add_setshow_boolean_cmd ("startup-quietly", class_support,
>  			       &startup_quiet, _("\
> -Set whether GDB should start up quietly."), _("		\
> +Set whether GDB should start up quietly."), _("\
>  Show whether GDB should start up quietly."), _("\
>  This setting will not affect the current session.  Instead this command\n\
>  should be added to the .gdbearlyinit file in the users home directory to\n\
  

>>>>> "Philippe" == Philippe Waroquiers <philippe.waroquiers@skynet.be> writes:

Philippe> Note that gdb/unittests/command-def-selftests.c checks various invariants about the
Philippe> command doc strings.
Philippe> We might add there a new invariant that there is no white space before a LF
Philippe> and no space at the end of doc string.

Philippe> This should avoid such problems to re-appear in the future.

I have a patch for this that I'll send momentarily.

Tom