From 7355e1a74d1ee30b0babb8835e10027eb04ef832 Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Wed, 14 Jun 2023 06:27:49 -0600 Subject: [PATCH] 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. --- gdb/python/lib/gdb/frames.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/gdb/python/lib/gdb/frames.py b/gdb/python/lib/gdb/frames.py index 0287a9bf3d3..4b2141ed722 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. -- 2.30.2