From 1868c57a5552e861f22ad550dd9e036819ad7b8f Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Sat, 10 Dec 2022 12:03:57 -0800 Subject: [PATCH 1/3] Added quick blurb on using bear for C extensions debugging --- doc/source/development/debugging_extensions.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/source/development/debugging_extensions.rst b/doc/source/development/debugging_extensions.rst index cfed8dfbc5a85..091cf92b9f713 100644 --- a/doc/source/development/debugging_extensions.rst +++ b/doc/source/development/debugging_extensions.rst @@ -119,3 +119,13 @@ Note that code execution under valgrind will take much longer than usual. While .. note:: For best results, you should run use a Python installation configured with Valgrind support (--with-valgrind) + + +Easier code navigation +====================== + +Generating a ``compile_commands.json`` file may make it easier to navigate the C extensions, as this makes it easier for your code editor to list references, jump to definitions, etc... To make this work with setuptools you may use the `Bear `_ application. + +.. code-block:: + + bear -- python setup.py build_ext --inplace -j4 --with-debugging-symbols From e4ca727731f31acb92487b8a6b1792e764ccf98c Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Sat, 10 Dec 2022 12:06:03 -0800 Subject: [PATCH 2/3] Edits --- doc/source/development/debugging_extensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/debugging_extensions.rst b/doc/source/development/debugging_extensions.rst index 091cf92b9f713..1da4d9dc13810 100644 --- a/doc/source/development/debugging_extensions.rst +++ b/doc/source/development/debugging_extensions.rst @@ -124,7 +124,7 @@ Note that code execution under valgrind will take much longer than usual. While Easier code navigation ====================== -Generating a ``compile_commands.json`` file may make it easier to navigate the C extensions, as this makes it easier for your code editor to list references, jump to definitions, etc... To make this work with setuptools you may use the `Bear `_ application. +Generating a ``compile_commands.json`` file may make it easier to navigate the C extensions, as this allows your code editor to list references, jump to definitions, etc... To make this work with setuptools you can use `Bear `_. .. code-block:: From b7bbb8ca0f496de18d520ba330d6dcfd8583382e Mon Sep 17 00:00:00 2001 From: Will Ayd Date: Sun, 11 Dec 2022 15:06:36 -0800 Subject: [PATCH 3/3] shell block --- doc/source/development/debugging_extensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/debugging_extensions.rst b/doc/source/development/debugging_extensions.rst index 1da4d9dc13810..32cb8f4c4d8cd 100644 --- a/doc/source/development/debugging_extensions.rst +++ b/doc/source/development/debugging_extensions.rst @@ -126,6 +126,6 @@ Easier code navigation Generating a ``compile_commands.json`` file may make it easier to navigate the C extensions, as this allows your code editor to list references, jump to definitions, etc... To make this work with setuptools you can use `Bear `_. -.. code-block:: +.. code-block:: sh bear -- python setup.py build_ext --inplace -j4 --with-debugging-symbols