jorisvandenbossche commented on a change in pull request #11505:
URL: https://github.com/apache/arrow/pull/11505#discussion_r733775843
##########
File path: docs/source/developers/python.rst
##########
@@ -57,6 +57,8 @@ like so:
pytest pyarrow
+Be sure to run the command inside arrow/python folder.
Review comment:
Another option could be to change the command above to `pytest
python/pyarrow`, assuming you are still in the root of the repo?
(personally I always do that, instead of moving to the python directory, but
that's maybe only my personal habit ..)
##########
File path: docs/source/developers/cpp/building.rst
##########
@@ -121,9 +121,23 @@ 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 optimization passes in the compiler and
+ leaves the symbol map in the binary.
+* ``FastDebug``
+* ``RelWithDebInfo``: applies compiler optimizations and it removes the symbol
+ map from the binary.
+* ``Release``: fast but less useful for debugging or profiling.
+* ``Profile_Gen``
+* ``Profile_Build``
+
+You can also run default build with flag `-DARROW_EXTRA_ERROR_CONTEXT=ON`, see
+:ref:`Extra debugging help`
Review comment:
For referencing another section in the document, you will need to add a
"label" to that section (if one doesn't exist yet) and use that label here
instead of the title. See
https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role
for some explanation of that.
##########
File path: docs/source/developers/cpp/building.rst
##########
@@ -121,9 +121,23 @@ 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 optimization passes in the compiler and
+ leaves the symbol map in the binary.
+* ``FastDebug``
+* ``RelWithDebInfo``: applies compiler optimizations and it removes the symbol
+ map from the binary.
+* ``Release``: fast but less useful for debugging or profiling.
+* ``Profile_Gen``
+* ``Profile_Build``
Review comment:
If we list them, we should probably explain them as well (but I can't
directly help with that ..)
And maybe we can also be opinionated on which ones to list and limit to the
ones we think are useful to list, and don't necessarily need to list all of
them.
(cc @westonpace)
--
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
