Author: Jacob Lalonde Date: 2025-01-24T14:59:56-08:00 New Revision: e2005d1461942539f7533a518aa78017074f6bf9
URL: https://github.com/llvm/llvm-project/commit/e2005d1461942539f7533a518aa78017074f6bf9 DIFF: https://github.com/llvm/llvm-project/commit/e2005d1461942539f7533a518aa78017074f6bf9.diff LOG: [LLDB] Reapply #123873 SBSaveCore Docstrings (#124355) In my last attempt at this (#123873), I didn't realize we needed semi colons! Also fixed the bug that the feature summary didn't have a type defined. CC @JDevlieghere hope you get a laugh at needing to revert doc strings for breaking the build.... Added: Modified: lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i Removed: ################################################################################ diff --git a/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i b/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i index e69de29bb2d1d6..08bbdf89d68ded 100644 --- a/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i +++ b/lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i @@ -0,0 +1,71 @@ +%feature("docstring", +"A container to specify how to save a core file. + +SBSaveCoreOptions includes API's to specify the memory regions and threads to include +when generating a core file. It extends the existing SaveCoreStyle option. + +* eSaveCoreFull will save off all thread and memory regions, ignoring the memory regions and threads in +the options object. + +* eSaveCoreDirtyOnly pages will capture all threads and all rw- memory regions, in addition to the regions specified +in the options object if they are not already captured. + +* eSaveCoreStackOnly will capture all threads, but no memory regions unless specified. + +* eSaveCoreCustomOnly Custom defers entirely to the SBSaveCoreOptions object and will only save what is specified. + Picking custom and specifying nothing will result in an error being returned. + +Note that currently ELF Core files are not supported." +) lldb::SBSaveCoreOptions; + +%feature("docstring", " + Set the plugin name to save a Core file with. Only plugins registered with Plugin manager will be accepted + Examples are Minidump and Mach-O." +) lldb::SBSaveCoreOptions::SetPluginName; + +%feature("docstring", " + Get the specified plugin name, or None if the name is not set." +) lldb::SBSaveCoreOptions::GetPluginName; + +%feature("docstring", " + Set the lldb.SaveCoreStyle." +) lldb::SBSaveCoreOptions::SetStyle; + +%feature("docstring", " + Get the specified lldb.SaveCoreStyle, or eSaveCoreUnspecified if not set." +) lldb::SBSaveCoreOptions::GetStyle; + +%feature("docstring", " + Set the file path to save the Core file at." +) lldb::SBSaveCoreOptions::SetOutputFile; + +%feature("docstring", " + Get an SBFileSpec corresponding to the specified output path, or none if not set." +) lldb::SBSaveCoreOptions::GetOutputFile; + +%feature("docstring", " + Set the process to save, or unset a process by providing a default SBProcess. + Resetting will result in the reset of all process specific options, such as Threads to save." +) lldb::SBSaveCoreOptions::SetProcess; + +%feature("docstring", " + Add an SBThread to be saved, an error will be returned if an SBThread from a diff erent process is specified. + The process is set either by the first SBThread added to the options container, or explicitly by the SetProcess call." +) lldb::SBSaveCoreOptions::AddThread; + +%feature("docstring", " + Remove an SBthread if present in the container, returns true if a matching thread was found and removed." +) lldb::SBSaveCoreOptions::RemoveThread; + +%feature("docstring", " + Add a memory region to save, an error will be returned in the region is invalid. + Ranges that overlap will be unioned into a single region." +) lldb::SBSaveCoreOptions::AddMemoryRegionToSave; + +%feature("docstring", " + Get an SBThreadCollection of all threads marked to be saved. This collection is not sorted according to insertion order." +) lldb::SBSaveCoreOptions::GetThreadsToSave; + +%feature("docstring", " + Unset all options." +) lldb::SBSaveCoreOptions::Clear; _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
