diff options
| author | Tom Tromey <tromey@adacore.com> | 2023-06-14 06:27:49 -0600 |
|---|---|---|
| committer | Tom Tromey <tromey@adacore.com> | 2023-07-10 13:17:30 -0600 |
| commit | 7355e1a74d1ee30b0babb8835e10027eb04ef832 (patch) | |
| tree | 97701ceae821482e0c8572b312b72247b809e57e | |
| parent | b812967a6033de7c0682a048588397f987ebf55c (diff) | |
| download | gdb-7355e1a74d1ee30b0babb8835e10027eb04ef832.zip gdb-7355e1a74d1ee30b0babb8835e10027eb04ef832.tar.gz gdb-7355e1a74d1ee30b0babb8835e10027eb04ef832.tar.bz2 | |
Fix execute_frame_filters doc string
When reading the doc string for execute_frame_filters, I wasn't sure
if the ranges were inclusive or exclusive. This patch updates the doc
string to reflect my findings, and also fixes an existing typo.
| -rw-r--r-- | gdb/python/lib/gdb/frames.py | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/gdb/python/lib/gdb/frames.py b/gdb/python/lib/gdb/frames.py index 0287a9b..4b2141e 100644 --- a/gdb/python/lib/gdb/frames.py +++ b/gdb/python/lib/gdb/frames.py @@ -165,18 +165,20 @@ def execute_frame_filters(frame, frame_low, frame_high): Arguments: frame: The initial frame. - frame_low: The low range of the slice. If this is a negative - integer then it indicates a backward slice (ie bt -4) which - counts backward from the last frame in the backtrace. + frame_low: The low range of the slice, counting from 0. If + this is a negative integer then it indicates a backward slice + (ie bt -4) which counts backward from the last frame in the + backtrace. - frame_high: The high range of the slice. If this is -1 then - it indicates all frames until the end of the stack from - frame_low. + frame_high: The high range of the slice, inclusive. If this + is -1 then it indicates all frames until the end of the stack + from frame_low. Returns: frame_iterator: The sliced iterator after all frame - filters have had a change to execute, or None if no frame + filters have had a chance to execute, or None if no frame filters are registered. + """ # Get a sorted list of frame filters. |