[PATCH] Fix help formatting for string and filename options

[PATCH] Fix help formatting for string and filename options

[Tom Tromey]

I happened to notice that "help add-inferior" said:

  -execFILENAME
    FILENAME is the file name of the executable to use as the
    main program.

This is missing a space after "-exec".  This patch fixes the bug.

If ok'd on time I plan to check this in to the gdb-16 branch as well.
---
 gdb/cli/cli-option.c               | 4 ++--
 gdb/testsuite/gdb.base/options.exp | 6 ++++++
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/gdb/cli/cli-option.c b/gdb/cli/cli-option.c
index 10a59449f7c..34ac1642b84 100644
--- a/gdb/cli/cli-option.c
+++ b/gdb/cli/cli-option.c
@@ -832,10 +832,10 @@ append_val_type_str (std::string &help, const option_def &opt,
       help += "NUMBER|#RRGGBB";
       break;
     case var_string:
-      help += "STRING";
+      help += " STRING";
       break;
     case var_filename:
-      help += "FILENAME";
+      help += " FILENAME";
       break;
     default:
       break;
diff --git a/gdb/testsuite/gdb.base/options.exp b/gdb/testsuite/gdb.base/options.exp
index e1ad61e6470..a1ca39eab11 100644
--- a/gdb/testsuite/gdb.base/options.exp
+++ b/gdb/testsuite/gdb.base/options.exp
@@ -1162,3 +1162,9 @@ test-thread-apply
 
 # Basic "info threads" integration tests.
 test-info-threads
+
+# There was a bug where the "metasyntactic variable" was glued to the
+# option.
+gdb_test "help maintenance test-options unknown-is-operand" \
+    "-string STRING.*-filename FILENAME.*" \
+    "option help has spaces"
-- 
2.47.1

Re: [PATCH] Fix help formatting for string and filename options

[Kevin Buettner]

On Mon, 13 Jan 2025 07:33:49 -0700
Tom Tromey <tromey@adacore.com> wrote:

> I happened to notice that "help add-inferior" said:
> 
>   -execFILENAME
>     FILENAME is the file name of the executable to use as the
>     main program.
> 
> This is missing a space after "-exec".  This patch fixes the bug.
> 
> If ok'd on time I plan to check this in to the gdb-16 branch as well.

LGTM.

Approved-by: Kevin Buettner <kevinb@redhat.com>