jorisvandenbossche commented on a change in pull request #11505:
URL: https://github.com/apache/arrow/pull/11505#discussion_r741747766
##########
File path: docs/source/developers/cpp/building.rst
##########
@@ -121,9 +121,21 @@ argument is omitted then a release build will be produced.
.. note::
- You need to more options to build on Windows. See
+ You need to set more options to build on Windows. See
:ref:`developers-cpp-windows` for details.
+Other options for build type are also possible:
+
+* ``Debug``: doesn't apply any compiler optimizations and leaves debugging
+ information in the binary.
+* ``RelWithDebInfo``: applies compiler optimizations while leaving debug
+ information in the binary.
+* ``Release``: applies compiler optimizations and removes debug information
+ from the binary.
+
+You can also run default build with flag `-DARROW_EXTRA_ERROR_CONTEXT=ON`, see
+:ref:`label-extra-debugging:`
Review comment:
```suggestion
:ref:`label-extra-debugging`
```
##########
File path: docs/source/developers/python.rst
##########
@@ -359,6 +364,10 @@ libraries), one can set ``--bundle-arrow-cpp``:
python setup.py build_ext --build-type=$ARROW_BUILD_TYPE \
--bundle-arrow-cpp bdist_wheel
+.. note::
+ To run an editable pyarrow version run ``pip install -e.
--no-build-isolation``
Review comment:
```suggestion
To run an editable pyarrow version run ``pip install -e .
--no-build-isolation``
```
##########
File path: docs/source/developers/cpp/building.rst
##########
@@ -121,9 +121,21 @@ argument is omitted then a release build will be produced.
.. note::
- You need to more options to build on Windows. See
+ You need to set more options to build on Windows. See
:ref:`developers-cpp-windows` for details.
+Other options for build type are also possible:
+
+* ``Debug``: doesn't apply any compiler optimizations and leaves debugging
+ information in the binary.
+* ``RelWithDebInfo``: applies compiler optimizations while leaving debug
+ information in the binary.
+* ``Release``: applies compiler optimizations and removes debug information
+ from the binary.
+
+You can also run default build with flag `-DARROW_EXTRA_ERROR_CONTEXT=ON`, see
Review comment:
```suggestion
You can also run default build with flag ``-DARROW_EXTRA_ERROR_CONTEXT=ON``,
see
```
(in restructuredtext we need two backticks for code)
##########
File path: docs/source/developers/python.rst
##########
@@ -306,6 +299,10 @@ adding flags with ``ON``:
Anything set to ``ON`` above can also be turned off. Note that some compression
libraries are needed for Parquet support.
+For better understanding of the error in case the build fails add flag
+``-DCMAKE_BUILD_TYPE=debug``. Read more about build type in C++ building
section
Review comment:
I think this flag doesn't help while building, but only afterwards when
running? (so the "in case the build fails" is then not correct; it's still
useful to point to the different build types though)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
