From cf0be7b4920cec762639a1f39e8ccf1868e44c40 Mon Sep 17 00:00:00 2001 From: Felipe de Azevedo Piovezan Date: Thu, 21 Dec 2023 09:04:24 -0300 Subject: [PATCH] [lldb] Add actionable feedback when overwriting a command fails (#76030) If adding a user commands fails because a command with the same name already exists, we only say that "force replace is not set" without telling the user _how_ to set it. There are two ways to do so; this commit changes the error message to mention both. --- lldb/source/Interpreter/CommandInterpreter.cpp | 6 +++++- .../commands/command/script/TestCommandScript.py | 13 +++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/lldb/source/Interpreter/CommandInterpreter.cpp b/lldb/source/Interpreter/CommandInterpreter.cpp index e1275ce711fc..00651df48b62 100644 --- a/lldb/source/Interpreter/CommandInterpreter.cpp +++ b/lldb/source/Interpreter/CommandInterpreter.cpp @@ -1160,7 +1160,11 @@ Status CommandInterpreter::AddUserCommand(llvm::StringRef name, if (UserCommandExists(name)) { if (!can_replace) { - result.SetErrorString("user command exists and force replace not set"); + result.SetErrorStringWithFormatv( + "user command \"{0}\" already exists and force replace was not set " + "by --overwrite or 'settings set interpreter.require-overwrite " + "false'", + name); return result; } if (cmd_sp->IsMultiwordObject()) { diff --git a/lldb/test/API/commands/command/script/TestCommandScript.py b/lldb/test/API/commands/command/script/TestCommandScript.py index cac11834fa73..850552032902 100644 --- a/lldb/test/API/commands/command/script/TestCommandScript.py +++ b/lldb/test/API/commands/command/script/TestCommandScript.py @@ -161,6 +161,19 @@ class CmdPythonTestCase(TestBase): ) self.expect("my_command", substrs=["a.out"]) + # Test that without --overwrite we are not allowed to redefine the command. + self.expect( + "command script add my_command --class welcome.TargetnameCommand", + substrs=[ + ( + 'user command "my_command" already exists and force replace was' + " not set by --overwrite or 'settings set" + " interpreter.require-overwrite false'" + ), + ], + error=True, + ) + self.runCmd("command script clear") self.expect(