Skip to content

Commit 781d2d0

Browse files
authored
[lldb] Fix some spelling and grammatical issues in Commands/Options.td (#156121)
Fixes whitespace, spelling and grammatical issues in the command options. I also formatted the affected options with clang-format and reflowed the description where necessary.
1 parent da7ce52 commit 781d2d0

File tree

1 file changed

+59
-34
lines changed

1 file changed

+59
-34
lines changed

lldb/source/Commands/Options.td

Lines changed: 59 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,12 @@ let Command = "breakpoint delete" in {
250250
def breakpoint_delete_dummy_breakpoints : Option<"dummy-breakpoints", "D">,
251251
Group<1>, Desc<"Delete Dummy breakpoints - i.e. breakpoints set before a "
252252
"file is provided, which prime new targets.">;
253-
def breakpoint_delete_disabled : Option<"disabled", "d">, Group<1>,
254-
Desc<"Delete all breakpoints which are currently disabled. When using the disabled option "
255-
"any breakpoints listed on the command line are EXCLUDED from deletion.">;
253+
def breakpoint_delete_disabled
254+
: Option<"disabled", "d">,
255+
Group<1>,
256+
Desc<"Delete all breakpoints which are currently disabled. When using "
257+
"the disabled option any breakpoints listed on the command line "
258+
"are EXCLUDED from deletion.">;
256259
}
257260

258261
let Command = "breakpoint name" in {
@@ -342,8 +345,10 @@ let Command = "disassemble" in {
342345
Desc<"Override the CPU for disassembling.">;
343346
def disassemble_options_features : Option<"features", "Y">, Arg<"CPUFeatures">,
344347
Desc<"Specify additional CPU features for disassembling.">;
345-
def disassemble_options_arch : Option<"arch", "A">, Arg<"Architecture">,
346-
Desc<"Specify the architecture to use from cross disassembly.">;
348+
def disassemble_options_arch
349+
: Option<"arch", "A">,
350+
Arg<"Architecture">,
351+
Desc<"Specify the architecture to use for cross disassembly.">;
347352
def disassemble_options_start_address : Option<"start-address", "s">,
348353
Groups<[1,2]>, Arg<"AddressOrExpression">, Required,
349354
Desc<"Address at which to start disassembling.">;
@@ -448,13 +453,17 @@ let Command = "frame recognizer add" in {
448453
Desc<"Give the name of a Python class to use for this frame recognizer.">;
449454
def frame_recognizer_regex : Option<"regex", "x">,
450455
Desc<"Function name and module name are actually regular expressions.">;
451-
def frame_recognizer_first_instruction_only : Option<"first-instruction-only", "f">, Arg<"Boolean">,
452-
Desc<"If true, only apply this recognizer to frames whose PC currently points to the "
453-
"first instruction of the specified function. If false, the recognizer "
454-
"will always be applied, regardless of the current position within the specified function. The "
455-
"implementer should keep in mind that some features, e.g. accessing function argument "
456-
"values via $arg<N>, are not guaranteed to work reliably in this case, so extra care must "
457-
"be taken to make the recognizer operate correctly. Defaults to true.">;
456+
def frame_recognizer_first_instruction_only
457+
: Option<"first-instruction-only", "f">,
458+
Arg<"Boolean">,
459+
Desc<"If true, only apply this recognizer to frames whose PC currently "
460+
"points to the first instruction of the specified function. If "
461+
"false, the recognizer will always be applied, regardless of the "
462+
"current position within the specified function. The implementer "
463+
"should keep in mind that some features, e.g., accessing function "
464+
"argument values via $arg<N>, are not guaranteed to work reliably "
465+
"in this case, so extra care must be taken to make the recognizer "
466+
"operate correctly. Defaults to true.">;
458467
}
459468

460469
let Command = "history" in {
@@ -672,9 +681,10 @@ let Command = "platform process list" in {
672681
def platform_process_list_show_args : Option<"show-args", "A">,
673682
GroupRange<1, 6>,
674683
Desc<"Show process arguments instead of the process executable basename.">;
675-
def platform_process_list_all_users: Option<"all-users", "x">,
676-
GroupRange<1,6>,
677-
Desc<"Show processes matching all user IDs.">;
684+
def platform_process_list_all_users
685+
: Option<"all-users", "x">,
686+
GroupRange<1, 6>,
687+
Desc<"Show processes matching all user IDs.">;
678688
def platform_process_list_verbose : Option<"verbose", "v">, GroupRange<1, 6>,
679689
Desc<"Enable verbose output.">;
680690
}
@@ -926,8 +936,11 @@ let Command = "source list" in {
926936
"indicate valid places to set source level breakpoints.">;
927937
def source_list_file : Option<"file", "f">, Group<1>, Arg<"Filename">,
928938
Completion<"SourceFile">, Desc<"The file from which to display source.">;
929-
def source_list_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
930-
Desc<"The line number at which to start the display source.">;
939+
def source_list_line
940+
: Option<"line", "l">,
941+
Group<1>,
942+
Arg<"LineNum">,
943+
Desc<"The line number at which to start displaying source.">;
931944
def source_list_name : Option<"name", "n">, Group<2>, Arg<"Symbol">,
932945
Completion<"Symbol">,
933946
Desc<"The name of a function whose source to display.">;
@@ -1089,12 +1102,14 @@ let Command = "target stop hook add" in {
10891102
def target_stop_hook_add_auto_continue : Option<"auto-continue", "G">,
10901103
Arg<"Boolean">, Desc<"The stop-hook will auto-continue after running its"
10911104
" commands.">;
1092-
def target_stop_hook_add_at_initial_stop : Option<"at-initial-stop", "I">,
1093-
Arg<"Boolean">, Desc<"Whether the stop-hook will trigger when lldb "
1094-
"initially gains control of the process. For a process launch, this "
1095-
"initial stop may happen very early on - before the loader has run. You "
1096-
"can use this option if you do not want some stop-hooks to run then. "
1097-
"Defaults to true.">;
1105+
def target_stop_hook_add_at_initial_stop
1106+
: Option<"at-initial-stop", "I">,
1107+
Arg<"Boolean">,
1108+
Desc<"Whether the stop-hook will trigger when lldb "
1109+
"initially gains control of the process. For a process launch, "
1110+
"this initial stop may happen very early on - before the loader "
1111+
"has run. You can use this option if you do not want some "
1112+
"stop-hooks to run then. Defaults to true.">;
10981113
}
10991114

11001115
let Command = "thread backtrace" in {
@@ -1120,12 +1135,16 @@ let Command = "thread step scope" in {
11201135
def thread_step_scope_count : Option<"count", "c">, Group<1>, Arg<"Count">,
11211136
Desc<"How many times to perform the stepping operation - currently only "
11221137
"supported for step-inst and next-inst.">;
1123-
def thread_step_scope_end_linenumber : Option<"end-linenumber", "e">,
1124-
Group<1>, Arg<"LineNum">, Desc<"The line at which to stop stepping - "
1125-
"defaults to the next line and only supported for step-in and step-over."
1126-
" You can also pass the string 'block' to step to the end of the current"
1127-
" block. This is particularly use in conjunction with --step-target to"
1128-
" step through a complex calling sequence.">;
1138+
def thread_step_scope_end_linenumber
1139+
: Option<"end-linenumber", "e">,
1140+
Group<1>,
1141+
Arg<"LineNum">,
1142+
Desc<"The line at which to stop stepping - "
1143+
"defaults to the next line and only supported for step-in and "
1144+
"step-over. You can also pass the string 'block' to step to the "
1145+
"end of the current block. This is particularly useful in "
1146+
"conjunction with --step-target to step through a complex calling "
1147+
"sequence.">;
11291148
def thread_step_scope_run_mode : Option<"run-mode", "m">, Group<1>,
11301149
EnumArg<"RunMode">, Desc<"Determine how to run other "
11311150
"threads while stepping the current thread.">;
@@ -1170,9 +1189,13 @@ let Command = "thread jump" in {
11701189
Completion<"SourceFile">, Desc<"Specifies the source file to jump to.">;
11711190
def thread_jump_line : Option<"line", "l">, Group<1>, Arg<"LineNum">,
11721191
Required, Desc<"Specifies the line number to jump to.">;
1173-
def thread_jump_by : Option<"by", "b">, Group<2>, Arg<"Offset">, Required,
1174-
Desc<"Jumps by a relative line offset from the current line,"
1175-
"can be a positive or negative offset">;
1192+
def thread_jump_by
1193+
: Option<"by", "b">,
1194+
Group<2>,
1195+
Arg<"Offset">,
1196+
Required,
1197+
Desc<"Jumps by a relative line offset from the current line, "
1198+
"can be a positive or negative offset.">;
11761199
def thread_jump_address : Option<"address", "a">, Group<3>,
11771200
Arg<"AddressOrExpression">, Required, Desc<"Jumps to a specific address.">;
11781201
def thread_jump_force : Option<"force", "r">, Groups<[1,2,3]>,
@@ -1394,8 +1417,10 @@ let Command = "type category enable" in {
13941417
}
13951418

13961419
let Command = "type category disable" in {
1397-
def type_category_disable_language : Option<"language", "l">, Arg<"Language">,
1398-
Desc<"Enable the category for this language.">;
1420+
def type_category_disable_language
1421+
: Option<"language", "l">,
1422+
Arg<"Language">,
1423+
Desc<"Disable the category for this language.">;
13991424
}
14001425

14011426
let Command = "type filter add" in {

0 commit comments

Comments
 (0)