Skip to content

Commit 5d3745b

Browse files
committed
Rephrase some sentences, and convert the behavior for each style into a bullet point list
1 parent dbe6334 commit 5d3745b

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
%feature("docstring",
2-
"A container for options to use when saving a core file.
2+
"A container to specify how to save a core file.
33
44
SBSaveCoreOptions includes API's to specify the memory regions and threads to include
5-
when generating a core file. These options are not exclusive the existing SaveCoreStyle option.
5+
when generating a core file. It extends the existing SaveCoreStyle option.
66
7-
Full will save off all thread and memory regions, ignoring the memory regions and threads in
7+
* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in
88
the options object.
99
10-
Dirty pages will capture all threads and all rw- memory regions, in addition to the regions specified
10+
* eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified
1111
in the options object if they are not already captured.
1212
13-
Stacks will capture all threads, but no memory regions unless specified.
13+
* eSaveCoreStackOnly will capture all threads, but no memory regions unless specified.
1414
15-
Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified.
16-
17-
Picking custom and specifying nothing will result in an error being returned.
15+
* eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified.
16+
Picking custom and specifying nothing will result in an error being returned.
1817
1918
Note that currently ELF Core files are not supported.
2019
")

0 commit comments

Comments
 (0)