[LLDB][Documentation] Add a doc string to sbprocess to show MemoryRegions is iterable #125557
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@JDevlieghere You think I should also update the summary of the SBMemoryRegionList type to note it's iterable? |
|
@llvm/pr-subscribers-lldb Author: Jacob Lalonde (Jlalond) ChangesMy colleague, @lukejriddle made the SBMemoryRegionList object iterable in #117358. This isn't documented anywhere and so I added a blurb about it to SBProcess. Full diff: https://github.com/llvm/llvm-project/pull/125557.diff 1 Files Affected:
diff --git a/lldb/bindings/interface/SBProcessDocstrings.i b/lldb/bindings/interface/SBProcessDocstrings.i
index 1b98a79e4f6d36..b5b22052a60944 100644
--- a/lldb/bindings/interface/SBProcessDocstrings.i
+++ b/lldb/bindings/interface/SBProcessDocstrings.i
@@ -258,3 +258,14 @@ SBProcess supports thread iteration. For example (from test/lldbutil.py), ::
Deallocates the block of memory (previously allocated using
AllocateMemory) given in the argument."
) lldb::SBProcess::DeallocateMemory;
+
+%feature("docstring", "
+ 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;
|
Icohedron
pushed a commit
to Icohedron/llvm-project
that referenced
this pull request
Feb 11, 2025
…ions is iterable (llvm#125557) My colleague, @lukejriddle made the SBMemoryRegionList object iterable in llvm#117358. This isn't documented anywhere and so I added a blurb about it to SBProcess.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
My colleague, @lukejriddle made the SBMemoryRegionList object iterable in #117358. This isn't documented anywhere and so I added a blurb about it to SBProcess.