jorisvandenbossche commented on code in PR #14260:
URL: https://github.com/apache/arrow/pull/14260#discussion_r982114159


##########
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:
   Now you mention to use both `python setup.py clean` and `git clean -Xfd .` 
from within the python directory. I think only mentioning the git way is 
sufficient? 
   Higher up in this file, we also only mention git clean (this was changed 
from setup.py to git clean in https://github.com/apache/arrow/pull/11505). And 
additionally, it's actually deprecated to call setup.py directly like that 
(https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html, although we 
still use it for `python setup.py build_ext` anyway .. but we can at least not 
mention it for cleaning)
   



-- 
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

Reply via email to