Skip to content

Commit dbe6334

Browse files
committed
Add draft docstrings for SBSaveCoreOptions
1 parent 1de3dc7 commit dbe6334

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
%feature("docstring",
2+
"A container for options to use when saving a core file.
3+
4+
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.
6+
7+
Full will save off all thread and memory regions, ignoring the memory regions and threads in
8+
the options object.
9+
10+
Dirty pages will capture all threads and all rw- memory regions, in addition to the regions specified
11+
in the options object if they are not already captured.
12+
13+
Stacks will capture all threads, but no memory regions unless specified.
14+
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.
18+
19+
Note that currently ELF Core files are not supported.
20+
")
21+
22+
%feature("docstring", "
23+
Set the plugin name to save a Core file with. Only plugins registered with Plugin manager will be accepted
24+
Examples are Minidump and Mach-O."
25+
) lldb::SBSaveCoreOptions::SetPluginName
26+
27+
%feature("docstring", "
28+
Get the specified plugin name, or None if the name is not set."
29+
) lldb::SBSaveCoreOptions::GetPluginName
30+
31+
%feature("docstring", "
32+
Set the lldb.SaveCoreStyle."
33+
) lldb::SBSaveCoreOptions::SetStyle
34+
35+
%feature("docstring", "
36+
Get the specified lldb.SaveCoreStyle, or eSaveCoreUnspecified if not set."
37+
) lldb::SBSaveCoreOptions::GetStyle
38+
39+
%feature("docstring", "
40+
Set the file path to save the Core file at."
41+
) lldb::SBSaveCoreOptions::SetOutputFile
42+
43+
%feature("docstring", "
44+
Get an SBFileSpec corresponding to the specified output path, or none if not set."
45+
) lldb::SBSaveCoreOptions::GetOutputFile
46+
47+
%feature("docstring", "
48+
Set the process to save, or unset a process by providing a default SBProcess.
49+
Resetting will result in the reset of all process specific options, such as Threads to save."
50+
) lldb::SBSaveCoreOptions::SetProcess
51+
52+
%feature("docstring", "
53+
Add an SBThread to be saved, an error will be returned if an SBThread from a different process is specified.
54+
The process is set either by the first SBThread added to the options container, or explicitly by the SetProcess call."
55+
) lldb::SBSaveCoreOptions::AddThread
56+
57+
%feature("docstring", "
58+
Remove an SBthread if present in the container, returns true if a matching thread was found and removed."
59+
) lldb::SBSaveCoreOptions::RemoveThread
60+
61+
%feature("docstring", "
62+
Add a memory region to save, an error will be returned in the region is invalid.
63+
Ranges that overlap will be unioned into a single region."
64+
) lldb::SBSaveCoreOptions::AddMemoryRegionToSave
65+
66+
%feature("docstring", "
67+
Get an SBThreadCollection of all threads marked to be saved. This collection is not sorted according to insertion order."
68+
) lldb::SBSaveCoreOptions::GetThreadsToSave
69+
70+
%feature("docstring", "
71+
Unset all options."
72+
) lldb::SBSaveCoreOptions::Clear

0 commit comments

Comments
 (0)