Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MINOR: [Docs][Python] Add more text around PyArrow build types #38522

Merged
merged 2 commits into from
Oct 31, 2023
Merged

MINOR: [Docs][Python] Add more text around PyArrow build types #38522

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
28290c0
Add more text around PyArrow build types
amoeba Oct 31, 2023
1c5f0e5
Update python.rst
amoeba Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/developers/python.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,12 @@ set the ``PYARROW_PARALLEL`` environment variable.
If you wish to delete stale PyArrow build artifacts before rebuilding, navigate
to the ``arrow/python`` folder and run ``git clean -Xfd .``.

By default, PyArrow will be built in release mode even if Arrow C++ has been
built in debug mode. To create a debug build of PyArrow, run
``export PYARROW_BUILD_TYPE=debug`` prior to running ``python setup.py
build_ext --inplace`` above. A ``relwithdebinfo`` build can be created
similarly.

Now you are ready to install test dependencies and run `Unit Testing`_, as
described above.

Expand Down Expand Up @@ -434,6 +440,9 @@ Debugging

Since pyarrow depends on the Arrow C++ libraries, debugging can
frequently involve crossing between Python and C++ shared libraries.
For the best experience, make sure you've built both Arrow C++
(``-DCMAKE_BUILD_TYPE=Debug``) and PyArrow (``export PYARROW_BUILD_TYPE=debug``)
in debug mode.

Using gdb on Linux
~~~~~~~~~~~~~~~~~~
Expand Down