intel/llvm
1
0
Fork 0
mirror of https://github.com/intel/llvm.git synced 2026-01-13 02:38:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

[LLDB][Docstrings] Fix some poorly formatted Docstrings (#129605)

Browse Source 
I was looking earlier on the public doc website, and noticed the
markdown was very badly mangled for this recent docstring that I added.
So I'm dropping the backticks and just leaving the snippet.


![image](https://github.com/user-attachments/assets/de63ab73-3bd5-4f8f-a07c-9f6accfee7e1)
This commit is contained in:
Jacob Lalonde
2025-03-06 18:57:54 -08:00
committed by GitHub
parent d5cef39d74
commit 5b1c281fca
3 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lldb/bindings/interface/SBProcessDocstrings.i
View File

@@ -260,12 +260,12 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
) lldb::SBProcess::DeallocateMemory;
%feature("docstring", "
Get a list of all the memory regions associated with this process.
```
Get a list of all the memory regions associated with this process. ::
readable_regions = []
for region in process.GetMemoryRegions():
if region.IsReadable():
readable_regions.append(region)
```
"
) lldb::SBProcess::GetMemoryRegions;

4
lldb/bindings/interface/SBProgressDocstrings.i
View File

@@ -23,7 +23,7 @@ specify a new detail. Some implementations differ on throttling updates and this
if the progress is deterministic or non-deterministic. For DAP, non-deterministic update messages have a higher
throttling rate than deterministic ones.
Below are examples in Python for deterministic and non-deterministic progresses.
Below are examples in Python for deterministic and non-deterministic progresses. ::
deterministic_progress1 = lldb.SBProgress('Deterministic Progress', 'Detail', 3, lldb.SBDebugger)
for i in range(3):
@@ -44,7 +44,7 @@ If you don't call Finalize() when the progress is not done, the progress object
garbage collected by the Python runtime, the end event will eventually get sent, but it is best not to
rely on the garbage collection when using lldb.SBProgress.
Non-deterministic progresses behave the same, but omit the total in the constructor.
Non-deterministic progresses behave the same, but omit the total in the constructor. ::
non_deterministic_progress = lldb.SBProgress('Non deterministic progress, 'Detail', lldb.SBDebugger)
for i in range(10):

9
lldb/bindings/interface/SBSaveCoreOptionsDocstrings.i
View File

@@ -4,16 +4,13 @@
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.
* 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.
* 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.
* 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;