jorisvandenbossche commented on code in PR #14260: URL: https://github.com/apache/arrow/pull/14260#discussion_r983320116
########## docs/source/developers/python.rst: ########## @@ -636,6 +636,52 @@ Caveats The Plasma component is not supported on Windows. +Deleting stale build artifacts +============================== + +When there have been changes to the structure of the Arrow C++ library or Pyarrow, +a thorough cleaning is recommended as a first attempt to fixing build errors. + +.. note:: + + It is not necessarily intuitive from the error itself that the problem is due to stale artifacts. + Example of a build error from stale artifacts is "Unknown CMake command "arrow_keep_backward_compatibility". + +To delete stale Arrow C++ build artifacts: + +.. code-block:: + + $ rm -rf arrow/cpp/build + +To delete stale PyArrow build artifacts: + +.. code-block:: + + $ pushd python + $ python3 setup.py clean Review Comment: One small follow-up comment: I would keep the `pushd python` when doing `git clean`, so it only cleans the python build artifacts, and not everything else (eg at this points in the explanation, you could first rebuild arrow cpp after cleaning that up, and then at that point you don't want to remove that again before doing a clean rebuild of pyarrow) Or I suppose doing `git clean -Xdf python` works as well, instead of pushd/popd to python -- 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]
