kou commented on code in PR #14260:
URL: https://github.com/apache/arrow/pull/14260#discussion_r981833265
##########
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".
Review Comment:
```suggestion
Example of a build error from stale artifacts is "Unknown CMake command
"arrow_keep_backward_compatibility"".
```
Or we can use a ReST markup instead of `"..."`.
##########
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
+ $ popd
Review Comment:
```suggestion
$ pushd python
$ python3 setup.py clean
$ popd
```
##########
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
+ $ popd
+
+To delete misc build artifacts that are hidden from ``git``:
+
+.. code-block::
+
+ $ git clean -Xfd .
Review Comment:
```suggestion
$ git clean -Xfd .
```
##########
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
Review Comment:
```suggestion
$ rm -rf arrow/cpp/build
```
##########
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
+ $ popd
+
+To delete misc build artifacts that are hidden from ``git``:
+
+.. code-block::
+
+ $ git clean -Xfd .
+
+If using a Conda environment, there are some build artifacts that get
installed in
+``$ARROW_HOME`` (aka ``$CONDA_PREFIX``). For example,
``$ARROW_HOME/lib/cmake/Arrow*``.
Review Comment:
We may want to remove `$ARROW_HOME/include/{arrow,gandiva,plasma}`,
`$ARROW_HOME/lib/lib{arrow,gandiva,plasma}*` and so on but we will not be able
to maintain the file lists to be removed...
So recreating a new Conda environment will be better.
--
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]
