westonpace commented on a change in pull request #11505: URL: https://github.com/apache/arrow/pull/11505#discussion_r734077844
########## File path: docs/source/developers/python.rst ########## @@ -106,8 +108,8 @@ Building on Linux and MacOS System Requirements ------------------- -On macOS, any modern XCode (6.4 or higher; the current version is 10) is -sufficient. +On macOS, any modern XCode (6.4 or higher; the current version is 13) is +sufficient. All you need is have XCode installed, no additional configuration is needed. Review comment: ```suggestion sufficient. All you need is to have XCode installed, no additional configuration is needed. ``` ########## 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: ```suggestion Be sure to run the command inside the arrow/python folder. ``` ########## 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 Review comment: ```suggestion * ``RelWithDebInfo``: applies compiler optimizations while leaving debug information in the binary ``` ########## File path: docs/source/developers/python.rst ########## @@ -335,17 +334,27 @@ virtualenv) enables cmake to choose the python executable which you are using. For any other C++ build challenges, see :ref:`cpp-development`. +In case you may need to rebuild the C++ part it is advisable to delete the content of +the build folder with command ``rm -rf *`` from the build folder. + Now, build pyarrow: .. code-block:: shell pushd arrow/python export PYARROW_WITH_PARQUET=1 + export PYARROW_WITH_FLIGHT=0 + export PYARROW_WITH_GANDIVA=0 + export PYARROW_WITH_ORC=0 + export PYARROW_WITH_PLASMA=0 python setup.py build_ext --inplace popd If you did not build one of the optional components, set the corresponding -``PYARROW_WITH_$COMPONENT`` environment variable to 0. +``PYARROW_WITH_$COMPONENT`` environment variable to 0 as in this example. + +If you wish to delete pyarrow build before rebuilding navigate to the ``arrow/python`` +folder and run ``python setp.py clean``. Review comment: ```suggestion folder and run ``python setup.py clean``. ``` ########## 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: Also, later (e.g. line 356 at the moment) you have: ``` ``arrow/python`` ``` I'm not sure if you want that here or not. ########## 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. Review comment: ```suggestion * ``Debug``: doesn't apply any optimization passes in the compiler and leaves debugging information in the binary. ``` "Symbol map" is a term I use a lot but it's probably too specific and not quite right. Debugging information is more generalized. ########## File path: docs/source/developers/python.rst ########## @@ -335,17 +334,27 @@ virtualenv) enables cmake to choose the python executable which you are using. For any other C++ build challenges, see :ref:`cpp-development`. +In case you may need to rebuild the C++ part it is advisable to delete the content of +the build folder with command ``rm -rf *`` from the build folder. + Now, build pyarrow: .. code-block:: shell pushd arrow/python export PYARROW_WITH_PARQUET=1 + export PYARROW_WITH_FLIGHT=0 + export PYARROW_WITH_GANDIVA=0 + export PYARROW_WITH_ORC=0 + export PYARROW_WITH_PLASMA=0 Review comment: All of the `PYARROW_WITH` flags default to 0 so it is a bit odd to see them explicitly set to 0 here. -- 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