Skip to content

Commit 7bee9d9

Browse files
JDevlieghereJDevlieghere
authored
[lldb] Reflow descriptions in source/Commands/Options.td (#156981)
Reflow command descriptions butchered by clang-format.
1 parent 1f0f347 commit 7bee9d9

File tree

1 file changed

+73
-91
lines changed

1 file changed

+73
-91
lines changed

‎lldb/source/Commands/Options.td‎

Lines changed: 73 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ let Command = "settings set" in {
4141
Desc<"${F}orce an empty value to be accepted as the default.">;
4242
def setset_exists
4343
: Option<"exists", "e">,
44-
Desc<"Set the setting if it ${e}xists, but do not cause "
45-
"the command to raise an error if it does not exist.">;
44+
Desc<"Set the setting if it ${e}xists, but do not cause the command to "
45+
"raise an error if it does not exist.">;
4646
}
4747

4848
let Command = "settings write" in {
@@ -85,16 +85,14 @@ let Command = "breakpoint list" in {
8585
: Option<"full", "f">,
8686
Group<2>,
8787
Desc<"Give a ${f}ull description of the breakpoint and its locations.">;
88-
def blist_verbose
89-
: Option<"verbose", "v">,
90-
Group<3>,
91-
Desc<"Explain everything we know about the breakpoint (for debugging "
92-
"debugger bugs).">;
88+
def blist_verbose : Option<"verbose", "v">,
89+
Group<3>,
90+
Desc<"Explain everything we know about the breakpoint "
91+
"(for debugging debugger bugs).">;
9392
def blist_dummy_bp
9493
: Option<"dummy-breakpoints", "D">,
95-
Desc<
96-
"List ${D}ummy breakpoints - i.e. breakpoints set before a file is "
97-
"provided, which prime new targets.">;
94+
Desc<"List ${D}ummy breakpoints - i.e. breakpoints set before a file "
95+
"is provided, which prime new targets.">;
9896
}
9997

10098
let Command = "breakpoint modify" in {
@@ -113,33 +111,33 @@ let Command = "breakpoint modify" in {
113111
: Option<"thread-index", "x">,
114112
Group<1>,
115113
Arg<"ThreadIndex">,
116-
Desc<"The breakpoint stops only for the thread whose "
117-
"inde${x} matches this argument.">;
114+
Desc<"The breakpoint stops only for the thread whose inde${x} matches "
115+
"this argument.">;
118116
def breakpoint_modify_thread_id
119117
: Option<"thread-id", "t">,
120118
Group<1>,
121119
Arg<"ThreadID">,
122-
Desc<"The breakpoint stops only for the ${t}hread whose TID "
123-
"matches this argument. The token 'current' resolves to the "
124-
"current thread's ID.">;
120+
Desc<"The breakpoint stops only for the ${t}hread whose TID matches "
121+
"this argument. The token 'current' resolves to the current "
122+
"thread's ID.">;
125123
def breakpoint_modify_thread_name
126124
: Option<"thread-name", "T">,
127125
Group<1>,
128126
Arg<"ThreadName">,
129-
Desc<"The breakpoint stops only for the thread whose "
130-
"thread name matches this argument.">;
127+
Desc<"The breakpoint stops only for the thread whose thread name "
128+
"matches this argument.">;
131129
def breakpoint_modify_queue_name
132130
: Option<"queue-name", "q">,
133131
Group<1>,
134132
Arg<"QueueName">,
135-
Desc<"The breakpoint stops only for threads in the queue "
136-
"whose name is given by this argument.">;
133+
Desc<"The breakpoint stops only for threads in the queue whose name is "
134+
"given by this argument.">;
137135
def breakpoint_modify_condition
138136
: Option<"condition", "c">,
139137
Group<1>,
140138
Arg<"Expression">,
141-
Desc<"The breakpoint stops only if this condition "
142-
"expression evaluates to true.">;
139+
Desc<"The breakpoint stops only if this condition expression evaluates "
140+
"to true.">;
143141
def breakpoint_modify_condition_language
144142
: Option<"condition-language", "Y">,
145143
Group<1>,
@@ -180,25 +178,22 @@ let Command = "breakpoint set" in {
180178
Arg<"ShlibName">,
181179
Completion<"Module">,
182180
Groups<[1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12]>, // *not* in group 10
183-
Desc<"${S}et the breakpoint only in this shared library. Can repeat "
184-
"this "
185-
"option multiple times to specify multiple shared libraries.">;
181+
Desc<
182+
"${S}et the breakpoint only in this shared library. Can repeat "
183+
"this option multiple times to specify multiple shared libraries.">;
186184
def breakpoint_set_hardware
187185
: Option<"hardware", "H">,
188186
Desc<"Require the breakpoint to use ${h}ardware breakpoints.">;
189-
def breakpoint_set_file : Option<"file", "f">,
190-
Arg<"Filename">,
191-
Completion<"SourceFile">,
192-
Groups<[1, 3, 4, 5, 6, 7, 8, 9, 11]>,
193-
Desc<"Specifies the source ${f}ile in which to set "
194-
"this breakpoint. Note, by "
195-
"default lldb only looks for files that are "
196-
"#included if they use the "
197-
"standard include file extensions. To set "
198-
"breakpoints on .c/.cpp/.m/.mm "
199-
"files that are #included, set "
200-
"target.inline-breakpoint-strategy to "
201-
"\"always\".">;
187+
def breakpoint_set_file
188+
: Option<"file", "f">,
189+
Arg<"Filename">,
190+
Completion<"SourceFile">,
191+
Groups<[1, 3, 4, 5, 6, 7, 8, 9, 11]>,
192+
Desc<"Specifies the source ${f}ile in which to set this breakpoint. "
193+
"Note, by default lldb only looks for files that are #included if "
194+
"they use the standard include file extensions. To set "
195+
"breakpoints on .c/.cpp/.m/.mm files that are #included, set "
196+
"target.inline-breakpoint-strategy to \"always\".">;
202197
def breakpoint_set_line
203198
: Option<"line", "l">,
204199
Group<1>,
@@ -215,59 +210,50 @@ let Command = "breakpoint set" in {
215210
Group<2>,
216211
Arg<"AddressOrExpression">,
217212
Required,
218-
Desc<
219-
"Set the breakpoint at the specified ${a}ddress. If the address "
220-
"maps "
221-
"uniquely to a particular binary, then the address will be "
222-
"converted to "
223-
"a \"file\"address, so that the breakpoint will track that "
224-
"binary+offset "
225-
"no matter where the binary eventually loads. Alternately, if you "
226-
"also "
227-
"specify the module - with the -s option - then the address will "
228-
"be "
229-
"treated as a file address in that module, and resolved "
230-
"accordingly. "
231-
"Again, this will allow lldb to track that offset on subsequent "
232-
"reloads. "
233-
"The module need not have been loaded at the time you specify this "
234-
"breakpoint, and will get resolved when the module is loaded.">;
235-
def breakpoint_set_name : Option<"name", "n">,
236-
Group<3>,
237-
Arg<"FunctionName">,
238-
Completion<"Symbol">,
239-
Required,
240-
Desc<"Set the breakpoint by function ${n}ame. Can "
241-
"be repeated multiple times to make one "
242-
"breakpoint for multiple names.">;
213+
Desc<"Set the breakpoint at the specified ${a}ddress. If the address "
214+
"maps uniquely to a particular binary, then the address will be "
215+
"converted to a \"file\"address, so that the breakpoint will "
216+
"track that binary+offset no matter where the binary eventually "
217+
"loads. Alternately, if you also specify the module - with the "
218+
"-s option - then the address will be treated as a file address "
219+
"in that module, and resolved accordingly. Again, this will "
220+
"allow lldb to track that offset on subsequent reloads. The "
221+
"module need not have been loaded at the time you specify this "
222+
"breakpoint, and will get resolved when the module is loaded.">;
223+
def breakpoint_set_name
224+
: Option<"name", "n">,
225+
Group<3>,
226+
Arg<"FunctionName">,
227+
Completion<"Symbol">,
228+
Required,
229+
Desc<"Set the breakpoint by function ${n}ame. Can be repeated "
230+
"multiple times to make one breakpoint for multiple names.">;
243231
def breakpoint_set_source_regexp_function
244232
: Option<"source-regexp-function", "X">,
245233
Group<9>,
246234
Arg<"FunctionName">,
247235
Completion<"Symbol">,
248236
Desc<"When used with '-p' limits the source regex to source contained "
249-
"in "
250-
"the named functions. Can be repeated multiple times.">;
237+
"in the named functions. Can be repeated multiple times.">;
251238
def breakpoint_set_fullname
252239
: Option<"fullname", "F">,
253240
Group<4>,
254241
Arg<"FullName">,
255242
Required,
256243
Completion<"Symbol">,
257-
Desc<
258-
"Set the breakpoint by ${F}ully qualified function names. For C++ "
259-
"this means namespaces and all arguments, and for Objective-C this "
260-
"means a full function prototype with class and selector. Can be "
261-
"repeated "
262-
"multiple times to make one breakpoint for multiple names.">;
244+
Desc<"Set the breakpoint by ${F}ully qualified function names. For C++ "
245+
"this means namespaces and all arguments, and for Objective-C "
246+
"this means a full function prototype with class and selector. "
247+
"Can be repeated multiple times to make one breakpoint for "
248+
"multiple names.">;
263249
def breakpoint_set_selector
264250
: Option<"selector", "S">,
265251
Group<5>,
266252
Arg<"Selector">,
267253
Required,
268254
Desc<"Set the breakpoint by Objective-C ${s}elector name. Can be "
269-
"repeated "
270-
"multiple times to make one breakpoint for multiple Selectors.">;
255+
"repeated multiple times to make one breakpoint for multiple "
256+
"Selectors.">;
271257
def breakpoint_set_method
272258
: Option<"method", "M">,
273259
Group<6>,
@@ -280,26 +266,24 @@ let Command = "breakpoint set" in {
280266
Group<7>,
281267
Arg<"RegularExpression">,
282268
Required,
283-
Desc<"Set the breakpoint by function "
284-
"name, evaluating a ${r}egular-expression to find the function "
285-
"name(s).">;
286-
def breakpoint_set_basename : Option<"basename", "b">,
287-
Group<8>,
288-
Arg<"FunctionName">,
289-
Required,
290-
Completion<"Symbol">,
291-
Desc<"Set the breakpoint by function "
292-
"${b}asename (C++ namespaces and arguments"
293-
" will be ignored). Can be repeated "
294-
"multiple times to make one breakpoint "
295-
"for multiple symbols.">;
269+
Desc<"Set the breakpoint by function name, evaluating a "
270+
"${r}egular-expression to find the function name(s).">;
271+
def breakpoint_set_basename
272+
: Option<"basename", "b">,
273+
Group<8>,
274+
Arg<"FunctionName">,
275+
Required,
276+
Completion<"Symbol">,
277+
Desc<"Set the breakpoint by function ${b}asename (C++ namespaces and "
278+
"arguments will be ignored). Can be repeated multiple times to "
279+
"make one breakpoint for multiple symbols.">;
296280
def breakpoint_set_source_pattern_regexp
297281
: Option<"source-pattern-regexp", "p">,
298282
Group<9>,
299283
Arg<"RegularExpression">,
300284
Required,
301-
Desc<"Set the breakpoint by specifying a regular expression which"
302-
" is matched against the source text in a source file or files "
285+
Desc<"Set the breakpoint by specifying a regular expression which is "
286+
"matched against the source text in a source file or files "
303287
"specified with the -f can be specified more than once. If no "
304288
"source files are specified, uses the current \"default source "
305289
"file\". If you want to match against all source files, ${p}ass "
@@ -314,8 +298,7 @@ let Command = "breakpoint set" in {
314298
Arg<"Language">,
315299
Required,
316300
Desc<"Set the breakpoint on ${e}xceptions thrown by the specified "
317-
"language "
318-
"(without options, on throw but not catch.)">;
301+
"language (without options, on throw but not catch.)">;
319302
def breakpoint_set_on_throw
320303
: Option<"on-throw", "w">,
321304
Group<10>,
@@ -350,8 +333,7 @@ let Command = "breakpoint set" in {
350333
Groups<[1, 3, 4, 5, 6, 7, 8, 12]>,
351334
Desc<"Add the specified offset to whatever address(es) the breakpoint "
352335
"${r}esolves to. At present this applies the offset directly as "
353-
"given, and "
354-
"doesn't try to align it to instruction boundaries.">;
336+
"given, and doesn't try to align it to instruction boundaries.">;
355337
def breakpoint_set_move_to_nearest_code
356338
: Option<"move-to-nearest-code", "m">,
357339
Groups<[1, 9, 12]>,

0 commit comments

Comments
 (0)