jorisvandenbossche commented on a change in pull request #11505:
URL: https://github.com/apache/arrow/pull/11505#discussion_r749341810
##########
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.
+Several build types are possible:
+
+* ``Debug``: doesn't apply any compiler optimizations and adds debugging
+ information in the binary.
+* ``RelWithDebInfo``: applies compiler optimizations while adding 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:`cpp-extra-debugging`.
```
##########
File path: docs/source/developers/python.rst
##########
@@ -55,12 +55,16 @@ like so:
.. code-block:: shell
- pytest pyarrow
+ pytest arrow/python/pyarrow
Package requirements to run the unit tests are found in
``requirements-test.txt`` and can be installed if needed with ``pip install -r
requirements-test.txt``.
+If you get import errors for ``pyarrow._lib`` or another PyArrow module when
+trying to run the tests run ``python -m pytest arrow/python/pyarrow`` and check
Review comment:
```suggestion
trying to run the tests, run ``python -m pytest arrow/python/pyarrow`` and
check
```
##########
File path: docs/source/developers/cpp/building.rst
##########
@@ -424,6 +436,8 @@ this can be accomplished with the ``Threads`` built-in
package:
find_package(Threads REQUIRED)
target_link_libraries(my_target PRIVATE Threads::Threads)
+.. _label-extra-debugging:
Review comment:
```suggestion
.. _cpp-extra-debugging:
```
(I propose to leave out "label", since this is indeed a label, but we
generally don't include that in the label's name, but adding cpp might be more
explicit when referencing this elsewhere)
##########
File path: docs/source/developers/python.rst
##########
@@ -306,6 +303,11 @@ adding flags with ``ON``:
Anything set to ``ON`` above can also be turned off. Note that some compression
libraries are needed for Parquet support.
+To enable C++ debugging information, pass the option
``-DCMAKE_BUILD_TYPE=debug``.
+
+.. seealso::
+ :ref:`cpp-building-building`.
Review comment:
Can you add a label to that section? (I think we are now using an
auto-generated one based on the title of the section)
So with the `.. _label:` syntax, like you also added a label for the
extra-debugging section.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
