Skip to content

[lldb] Correct style of error messages #156774

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 4, 2025
Merged

[lldb] Correct style of error messages #156774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lldb/source/API/SBCommandInterpreter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ void SBCommandInterpreter::HandleCommandsFromFile(
LLDB_INSTRUMENT_VA(this, file, override_context, options, result);

if (!IsValid()) {
result->AppendError("SBCommandInterpreter is not valid.");
result->AppendError("SBCommandInterpreter is not valid");
return;
}

Expand Down
36 changes: 18 additions & 18 deletions lldb/source/Commands/CommandObjectBreakpoint.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,12 +609,12 @@ class CommandObjectBreakpointSet : public CommandObjectParsed {
const size_t num_files = m_options.m_filenames.GetSize();
if (num_files == 0) {
if (!GetDefaultFile(target, file, result)) {
result.AppendError("No file supplied and no default file available.");
result.AppendError("no file supplied and no default file available");
return;
}
} else if (num_files > 1) {
result.AppendError("Only one file at a time is allowed for file and "
"line breakpoints.");
result.AppendError("only one file at a time is allowed for file and "
"line breakpoints");
return;
} else
file = m_options.m_filenames.GetFileSpecAtIndex(0);
Expand Down Expand Up @@ -784,7 +784,7 @@ class CommandObjectBreakpointSet : public CommandObjectParsed {
}
result.SetStatus(eReturnStatusSuccessFinishResult);
} else if (!bp_sp) {
result.AppendError("Breakpoint creation failed: No breakpoint created.");
result.AppendError("breakpoint creation failed: no breakpoint created");
}
}

Expand Down Expand Up @@ -940,7 +940,7 @@ class CommandObjectBreakpointEnable : public CommandObjectParsed {
size_t num_breakpoints = breakpoints.GetSize();

if (num_breakpoints == 0) {
result.AppendError("No breakpoints exist to be enabled.");
result.AppendError("no breakpoints exist to be enabled");
return;
}

Expand Down Expand Up @@ -1048,7 +1048,7 @@ the second re-enables the first location.");
size_t num_breakpoints = breakpoints.GetSize();

if (num_breakpoints == 0) {
result.AppendError("No breakpoints exist to be disabled.");
result.AppendError("no breakpoints exist to be disabled");
return;
}

Expand Down Expand Up @@ -1224,7 +1224,7 @@ class CommandObjectBreakpointList : public CommandObjectParsed {
}
result.SetStatus(eReturnStatusSuccessFinishNoResult);
} else {
result.AppendError("Invalid breakpoint ID.");
result.AppendError("invalid breakpoint ID");
}
}
}
Expand Down Expand Up @@ -1318,7 +1318,7 @@ class CommandObjectBreakpointClear : public CommandObjectParsed {

// Early return if there's no breakpoint at all.
if (num_breakpoints == 0) {
result.AppendError("Breakpoint clear: No breakpoint cleared.");
result.AppendError("breakpoint clear: no breakpoint cleared");
return;
}

Expand Down Expand Up @@ -1364,7 +1364,7 @@ class CommandObjectBreakpointClear : public CommandObjectParsed {
output_stream.EOL();
result.SetStatus(eReturnStatusSuccessFinishNoResult);
} else {
result.AppendError("Breakpoint clear: No breakpoint cleared.");
result.AppendError("breakpoint clear: no breakpoint cleared");
}
}

Expand Down Expand Up @@ -1459,7 +1459,7 @@ class CommandObjectBreakpointDelete : public CommandObjectParsed {
size_t num_breakpoints = breakpoints.GetSize();

if (num_breakpoints == 0) {
result.AppendError("No breakpoints exist to be deleted.");
result.AppendError("no breakpoints exist to be deleted");
return;
}

Expand Down Expand Up @@ -1504,7 +1504,7 @@ class CommandObjectBreakpointDelete : public CommandObjectParsed {
}
}
if (valid_bp_ids.GetSize() == 0) {
result.AppendError("No disabled breakpoints.");
result.AppendError("no disabled breakpoints");
return;
}
} else {
Expand Down Expand Up @@ -1712,7 +1712,7 @@ class CommandObjectBreakpointNameConfigure : public CommandObjectParsed {

const size_t argc = command.GetArgumentCount();
if (argc == 0) {
result.AppendError("No names provided.");
result.AppendError("no names provided");
return;
}

Expand Down Expand Up @@ -1799,7 +1799,7 @@ class CommandObjectBreakpointNameAdd : public CommandObjectParsed {
protected:
void DoExecute(Args &command, CommandReturnObject &result) override {
if (!m_name_options.m_name.OptionWasSet()) {
result.AppendError("No name option provided.");
result.AppendError("no name option provided");
return;
}

Expand All @@ -1813,7 +1813,7 @@ class CommandObjectBreakpointNameAdd : public CommandObjectParsed {

size_t num_breakpoints = breakpoints.GetSize();
if (num_breakpoints == 0) {
result.AppendError("No breakpoints, cannot add names.");
result.AppendError("no breakpoints, cannot add names");
return;
}

Expand All @@ -1825,7 +1825,7 @@ class CommandObjectBreakpointNameAdd : public CommandObjectParsed {

if (result.Succeeded()) {
if (valid_bp_ids.GetSize() == 0) {
result.AppendError("No breakpoints specified, cannot add names.");
result.AppendError("no breakpoints specified, cannot add names");
return;
}
size_t num_valid_ids = valid_bp_ids.GetSize();
Expand Down Expand Up @@ -1873,7 +1873,7 @@ class CommandObjectBreakpointNameDelete : public CommandObjectParsed {
protected:
void DoExecute(Args &command, CommandReturnObject &result) override {
if (!m_name_options.m_name.OptionWasSet()) {
result.AppendError("No name option provided.");
result.AppendError("no name option provided");
return;
}

Expand All @@ -1887,7 +1887,7 @@ class CommandObjectBreakpointNameDelete : public CommandObjectParsed {

size_t num_breakpoints = breakpoints.GetSize();
if (num_breakpoints == 0) {
result.AppendError("No breakpoints, cannot delete names.");
result.AppendError("no breakpoints, cannot delete names");
return;
}

Expand All @@ -1899,7 +1899,7 @@ class CommandObjectBreakpointNameDelete : public CommandObjectParsed {

if (result.Succeeded()) {
if (valid_bp_ids.GetSize() == 0) {
result.AppendError("No breakpoints specified, cannot delete names.");
result.AppendError("no breakpoints specified, cannot delete names");
return;
}
ConstString bp_name(m_name_options.m_name.GetCurrentValue());
Expand Down
4 changes: 2 additions & 2 deletions lldb/source/Commands/CommandObjectCommands.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,7 @@ other command as far as there is only one alias command match.");
if ((pos != std::string::npos) && (pos > 0))
raw_command_string = raw_command_string.substr(pos);
} else {
result.AppendError("Error parsing command string. No alias created.");
result.AppendError("error parsing command string. No alias created");
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it is multiple sentences, does the guidance say anything about that?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does, yeah, it even includes an example (which I know you couldn't see because of the infra issue):

error: file.o: section header 3 is corrupt. Size is 10 when it should be 20

The double spaces is something else we should settle on, but that's a separate discussion...

return;
}

Expand Down Expand Up @@ -2888,7 +2888,7 @@ class CommandObjectCommandsContainerDelete : public CommandObjectParsed {
size_t num_args = command.GetArgumentCount();

if (num_args == 0) {
result.AppendError("No command was specified.");
result.AppendError("no command was specified");
return;
}

Expand Down
8 changes: 4 additions & 4 deletions lldb/source/Commands/CommandObjectFrame.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,15 +140,15 @@ class CommandObjectFrameDiagnose : public CommandObjectParsed {
} else {
StopInfoSP stop_info_sp = thread->GetStopInfo();
if (!stop_info_sp) {
result.AppendError("No arguments provided, and no stop info.");
result.AppendError("no arguments provided, and no stop info");
return;
}

valobj_sp = StopInfo::GetCrashingDereference(stop_info_sp);
}

if (!valobj_sp) {
result.AppendError("No diagnosis available.");
result.AppendError("no diagnosis available");
return;
}

Expand Down Expand Up @@ -310,7 +310,7 @@ class CommandObjectFrameSelect : public CommandObjectParsed {
if (frame_idx == 0) {
// If you are already at the bottom of the stack, then just warn
// and don't reset the frame.
result.AppendError("Already at the bottom of the stack.");
result.AppendError("already at the bottom of the stack");
return;
} else
frame_idx = 0;
Expand All @@ -335,7 +335,7 @@ class CommandObjectFrameSelect : public CommandObjectParsed {
if (frame_idx == num_frames - 1) {
// If we are already at the top of the stack, just warn and don't
// reset the frame.
result.AppendError("Already at the top of the stack.");
result.AppendError("already at the top of the stack");
return;
} else
frame_idx = num_frames - 1;
Expand Down
2 changes: 1 addition & 1 deletion lldb/source/Commands/CommandObjectLog.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ class CommandObjectLogTimerIncrement : public CommandObjectParsed {
Timer::SetQuiet(!increment);
result.SetStatus(eReturnStatusSuccessFinishNoResult);
} else
result.AppendError("Could not convert increment value to boolean.");
result.AppendError("could not convert increment value to boolean");
}

if (!result.Succeeded()) {
Expand Down
2 changes: 1 addition & 1 deletion lldb/source/Commands/CommandObjectMultiword.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ void CommandObjectMultiword::Execute(const char *args_string,

auto sub_command = args[0].ref();
if (sub_command.empty()) {
result.AppendError("Need to specify a non-empty subcommand.");
result.AppendError("need to specify a non-empty subcommand");
return;
}

Expand Down
2 changes: 1 addition & 1 deletion lldb/source/Commands/CommandObjectProcess.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ class CommandObjectProcessLaunch : public CommandObjectProcessLaunchOrAttach {
if (!exe_module_sp)
exe_module_sp = target->GetExecutableModule();
if (!exe_module_sp) {
result.AppendWarning("Could not get executable module after launch.");
result.AppendWarning("could not get executable module after launch");
} else {

const char *archname =
Expand Down
6 changes: 3 additions & 3 deletions lldb/source/Commands/CommandObjectSource.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ class CommandObjectSourceInfo : public CommandObjectParsed {
"No selected frame to use to find the default source.");
return false;
} else if (!cur_frame->HasDebugInformation()) {
result.AppendError("No debug info for the selected frame.");
result.AppendError("no debug info for the selected frame");
return false;
} else {
const SymbolContext &sc =
Expand Down Expand Up @@ -553,11 +553,11 @@ class CommandObjectSourceInfo : public CommandObjectParsed {
}
}
if (!m_module_list.GetSize()) {
result.AppendError("No modules match the input.");
result.AppendError("no modules match the input");
return;
}
} else if (target.GetImages().GetSize() == 0) {
result.AppendError("The target has no associated executable images.");
result.AppendError("the target has no associated executable images");
return;
}

Expand Down
6 changes: 3 additions & 3 deletions lldb/source/Commands/CommandObjectTarget.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2420,7 +2420,7 @@ class CommandObjectTargetModulesDumpLineTable
result.GetErrorStream().SetAddressByteSize(addr_byte_size);

if (command.GetArgumentCount() == 0) {
result.AppendError("file option must be specified.");
result.AppendError("file option must be specified");
return;
} else {
// Dump specified images (by basename or fullpath)
Expand Down Expand Up @@ -3565,13 +3565,13 @@ class CommandObjectTargetModulesShowUnwind : public CommandObjectParsed {

ThreadList threads(process->GetThreadList());
if (threads.GetSize() == 0) {
result.AppendError("The process must be paused to use this command.");
result.AppendError("the process must be paused to use this command");
return;
}

ThreadSP thread(threads.GetThreadAtIndex(0));
if (!thread) {
result.AppendError("The process must be paused to use this command.");
result.AppendError("the process must be paused to use this command");
return;
}

Expand Down
2 changes: 1 addition & 1 deletion lldb/source/Commands/CommandObjectThread.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1570,7 +1570,7 @@ class CommandObjectThreadReturn : public CommandObjectRaw {
uint32_t frame_idx = frame_sp->GetFrameIndex();

if (frame_sp->IsInlined()) {
result.AppendError("Don't know how to return from inlined frames.");
result.AppendError("don't know how to return from inlined frames");
return;
}

Expand Down
Loading
Loading