Use internal_dict everywhere we refer to the python session dict in docs.
GitOrigin-RevId: 483ec136da7193de781a5284f1c37929cc27c05c
diff --git a/docs/use/python-reference.rst b/docs/use/python-reference.rst
index f3ce744..a1bdc87 100644
--- a/docs/use/python-reference.rst
+++ b/docs/use/python-reference.rst
@@ -179,35 +179,35 @@
::
- def breakpoint_function_wrapper(frame, bp_loc, dict):
+ def breakpoint_function_wrapper(frame, bp_loc, internal_dict):
# Your code goes here
or:
::
- def breakpoint_function_wrapper(frame, bp_loc, extra_args, dict):
+ def breakpoint_function_wrapper(frame, bp_loc, extra_args, internal_dict):
# Your code goes here
-+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| Argument | Type | Description |
-+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| **frame** | **lldb.SBFrame** | The current stack frame where the breakpoint got hit. |
-| | | The object will always be valid. |
-| | | This **frame** argument might *not* match the currently selected stack frame found in the **lldb** module global variable **lldb.frame**. |
-+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| **bp_loc** | **lldb.SBBreakpointLocation** | The breakpoint location that just got hit. Breakpoints are represented by **lldb.SBBreakpoint** |
-| | | objects. These breakpoint objects can have one or more locations. These locations |
-| | | are represented by **lldb.SBBreakpointLocation** objects. |
-+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| **extra_args** | **lldb.SBStructuredData** | **Optional** If your breakpoint callback function takes this extra parameter, then when the callback gets added to a breakpoint, its |
-| | | contents can parametrize this use of the callback. For instance, instead of writing a callback that stops when the caller is "Foo", |
-| | | you could take the function name from a field in the **extra_args**, making the callback more general. The **-k** and **-v** options |
-| | | to **breakpoint command add** will be passed as a Dictionary in the **extra_args** parameter, or you can provide it with the SB API's. |
-+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| **dict** | **dict** | The python session dictionary as a standard python dictionary object. |
-+----------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
++-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Argument | Type | Description |
++-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| **frame** | **lldb.SBFrame** | The current stack frame where the breakpoint got hit. |
+| | | The object will always be valid. |
+| | | This **frame** argument might *not* match the currently selected stack frame found in the **lldb** module global variable **lldb.frame**. |
++-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| **bp_loc** | **lldb.SBBreakpointLocation** | The breakpoint location that just got hit. Breakpoints are represented by **lldb.SBBreakpoint** |
+| | | objects. These breakpoint objects can have one or more locations. These locations |
+| | | are represented by **lldb.SBBreakpointLocation** objects. |
++-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| **extra_args** | **lldb.SBStructuredData** | **Optional** If your breakpoint callback function takes this extra parameter, then when the callback gets added to a breakpoint, its |
+| | | contents can parametrize this use of the callback. For instance, instead of writing a callback that stops when the caller is "Foo", |
+| | | you could take the function name from a field in the **extra_args**, making the callback more general. The **-k** and **-v** options |
+| | | to **breakpoint command add** will be passed as a Dictionary in the **extra_args** parameter, or you can provide it with the SB API's. |
++-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| **internal_dict** | **dict** | The python session dictionary as a standard python dictionary object. |
++-------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Optionally, a Python breakpoint command can return a value. Returning False
tells LLDB that you do not want to stop at the breakpoint. Any other return
@@ -546,7 +546,7 @@
::
class CommandObjectType:
- def __init__(self, debugger, session_dict):
+ def __init__(self, debugger, internal_dict):
this call should initialize the command with respect to the command interpreter for the passed-in debugger
def __call__(self, debugger, command, exe_ctx, result):
this is the actual bulk of the command, akin to Python command functions
diff --git a/source/Commands/CommandObjectBreakpointCommand.cpp b/source/Commands/CommandObjectBreakpointCommand.cpp
index 1b21495..3489b5c 100644
--- a/source/Commands/CommandObjectBreakpointCommand.cpp
+++ b/source/Commands/CommandObjectBreakpointCommand.cpp
@@ -119,12 +119,12 @@
The function itself must have either of the following prototypes:
-def breakpoint_callback(frame, bp_loc, dict):
+def breakpoint_callback(frame, bp_loc, internal_dict):
# Your code goes here
or:
-def breakpoint_callback(frame, bp_loc, extra_args, dict):
+def breakpoint_callback(frame, bp_loc, extra_args, internal_dict):
# Your code goes here
)"
