kou commented on code in PR #34463:
URL: https://github.com/apache/arrow/pull/34463#discussion_r1127009328
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
Review Comment:
```suggestion
- PYARROW_BUILD_TYPE (release, debug or relwithdebinfo)
```
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
Review Comment:
How about removing them because we deprecate Plasma?
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
Review Comment:
Is header missing?
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
+ * - PYARROW_CXXFLAGS
+ - Extra cxx flags
+ * - PYARROW_WITH_STATIC_PARQUET
+ - Rely on parquet shared libraries where relevant, default OFF
+ * - PYARROW_WITH_STATIC_BOOST
+ - Rely on Boost shared libraries on linking static parquet, default OFF
+ * - PYARROW_GENERATE_COVERAGE
+ - Setting ``Xlinetrace`` flag to true for the Cython compiler
+ * - PYARROW_BUNDLE_ARROW_CPP
+ - Bundle the Arrow C++ libraries, default OFF
+ * - PYARROW_BUNDLE_CYTHON_CPP
+ - Bundle the C++ files generated by Cython, default OFF
+ * - PYARROW_BUNDLE_BOOST
+ - Bundle the Boost libraries when we bundle Arrow C++, default OFF
+ * - PYARROW_BUNDLE_ARROW_CPP_HEADERS
+ - Bundle the Arrow C++ headers
+ * - PYARROW_BUNDLE_PLASMA_EXECUTABLE
+ - Bundle the plasma-store-server, default ON
Review Comment:
How about remove this?
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
+ * - PYARROW_CXXFLAGS
+ - Extra cxx flags
+ * - PYARROW_WITH_STATIC_PARQUET
+ - Rely on parquet shared libraries where relevant, default OFF
+ * - PYARROW_WITH_STATIC_BOOST
+ - Rely on Boost shared libraries on linking static parquet, default OFF
+ * - PYARROW_GENERATE_COVERAGE
+ - Setting ``Xlinetrace`` flag to true for the Cython compiler
+ * - PYARROW_BUNDLE_ARROW_CPP
+ - Bundle the Arrow C++ libraries, default OFF
+ * - PYARROW_BUNDLE_CYTHON_CPP
+ - Bundle the C++ files generated by Cython, default OFF
+ * - PYARROW_BUNDLE_BOOST
+ - Bundle the Boost libraries when we bundle Arrow C++, default OFF
+ * - PYARROW_BUNDLE_ARROW_CPP_HEADERS
+ - Bundle the Arrow C++ headers
+ * - PYARROW_BUNDLE_PLASMA_EXECUTABLE
+ - Bundle the plasma-store-server, default ON
+ * - PYARROW_INSTALL_TESTS
+ - Add the test to the python package, default ON
+ * - PYARROW_BUILD_VERBOSE
+ - Enable verbose output from Makefile builds, default OFF
+ * - PYARROW_PARALLEL
+ - Number of threads used to compile PyArrow’s C++/Cython components
Review Comment:
```suggestion
- Number of processes used to compile PyArrow’s C++/Cython components
```
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
+ * - PYARROW_CXXFLAGS
+ - Extra cxx flags
Review Comment:
```suggestion
- Extra C++ compiler flags
```
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
Review Comment:
```suggestion
- Name of install folder for Boost (if different from 'boost')
```
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
Review Comment:
* How about specify option value explicitly in example because users need to
specify option value?
* How about specify two options in example to show users can specify
multiple options?
```suggestion
- Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL=NONE
-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64"``)
```
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
+ * - PYARROW_CXXFLAGS
+ - Extra cxx flags
+ * - PYARROW_WITH_STATIC_PARQUET
+ - Rely on parquet shared libraries where relevant, default OFF
+ * - PYARROW_WITH_STATIC_BOOST
+ - Rely on Boost shared libraries on linking static parquet, default OFF
+ * - PYARROW_GENERATE_COVERAGE
+ - Setting ``Xlinetrace`` flag to true for the Cython compiler
+ * - PYARROW_BUNDLE_ARROW_CPP
+ - Bundle the Arrow C++ libraries, default OFF
+ * - PYARROW_BUNDLE_CYTHON_CPP
+ - Bundle the C++ files generated by Cython, default OFF
+ * - PYARROW_BUNDLE_BOOST
+ - Bundle the Boost libraries when we bundle Arrow C++, default OFF
+ * - PYARROW_BUNDLE_ARROW_CPP_HEADERS
+ - Bundle the Arrow C++ headers
Review Comment:
Ah, we can remove this.
It's for `include/arrow/python/`. We always install `include/arrow/python/`
(and bundle `include/arrow/`) now because we moved `cpp/src/arrow/python/` to
`python/`.
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
+ * - PYARROW_CXXFLAGS
+ - Extra cxx flags
+ * - PYARROW_WITH_STATIC_PARQUET
+ - Rely on parquet shared libraries where relevant, default OFF
+ * - PYARROW_WITH_STATIC_BOOST
+ - Rely on Boost shared libraries on linking static parquet, default OFF
Review Comment:
Because `setup.py` uses `STATIC` (not `SHARED`) and `CMakeLists.txt` uses
`SHARED` (not `STATIC`).
(We can change `CMakeLists.txt` to use `STATIC` to align names in `setup.py`
and `CMakeLists.txt` for easy to understand.)
We can remove `PYARROW_WITH_STATIC_BOOST` because we don't use Boost now.
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
Review Comment:
How about adding one more column for the default value?
Most rows include the default value information in the "Description" column.
##########
docs/source/developers/python.rst:
##########
@@ -586,6 +586,86 @@ Caveats
The Plasma component is not supported on Windows.
+Relevant components and environment variables
+=============================================
+
+List of relevant Arrow CMake flags and corresponding environment variables
+to be used when building PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - CMAKE_BUILD_TYPE
+ - PYARROW_BUILD_TYPE (release, dbug or relwithdebinfo)
+ * - ARROW_GCS
+ - PYARROW_WITH_GCS
+ * - ARROW_S3
+ - PYARROW_WITH_S3
+ * - ARROW_HDFS
+ - PYARROW_WITH_HDFS
+ * - ARROW_CUDA
+ - PYARROW_WITH_CUDA
+ * - ARROW_SUBSTRAIT
+ - PYARROW_WITH_SUBSTRAIT
+ * - ARROW_FLIGHT
+ - PYARROW_WITH_FLIGHT
+ * - ARROW_DATASET
+ - PYARROW_WITH_DATASET
+ * - ARROW_PARQUET
+ - PYARROW_WITH_PARQUET
+ * - PARQUET_REQUIRE_ENCRYPTION
+ - PYARROW_WITH_PARQUET_ENCRYPTION
+ * - ARROW_PLASMA
+ - PYARROW_WITH_PLASMA
+ * - ARROW_TENSORFLOW
+ - PYARROW_WITH_TENSORFLOW
+ * - ARROW_ORC
+ - PYARROW_WITH_ORC
+ * - ARROW_GANDIVA
+ - PYARROW_WITH_GANDIVA
+
+List of relevant environment variables that can also be used to build
+PyArrow are:
+
+.. list-table::
+ :widths: 30 30
+ :header-rows: 1
+
+ * - PyArrow environment variable
+ - Description
+ * - PYARROW_CMAKE_GENERATOR
+ - Example: 'Visual Studio 15 2017 Win64'
+ * - PYARROW_CMAKE_OPTIONS
+ - Extra CMake and Arrow options (ex. ``"-DARROW_SIMD_LEVEL"``,
+ ``"-DCMAKE_OSX_ARCHITECTURES"``)
+ * - PYARROW_BOOST_NAMESPACE
+ - Name of install folder for boost (if different from 'boost')
+ * - PYARROW_CXXFLAGS
+ - Extra cxx flags
+ * - PYARROW_WITH_STATIC_PARQUET
+ - Rely on parquet shared libraries where relevant, default OFF
+ * - PYARROW_WITH_STATIC_BOOST
+ - Rely on Boost shared libraries on linking static parquet, default OFF
+ * - PYARROW_GENERATE_COVERAGE
+ - Setting ``Xlinetrace`` flag to true for the Cython compiler
+ * - PYARROW_BUNDLE_ARROW_CPP
+ - Bundle the Arrow C++ libraries, default OFF
+ * - PYARROW_BUNDLE_CYTHON_CPP
+ - Bundle the C++ files generated by Cython, default OFF
+ * - PYARROW_BUNDLE_BOOST
+ - Bundle the Boost libraries when we bundle Arrow C++, default OFF
Review Comment:
I should have removed this in #14925.
This is not used now because Apache Arrow C++'s library part doesn't depend
on Boost libraries. (Tests may depend on Boost libraries. Apache Arrow C++'s
library part may depend on Boost but it just uses header-only part of Boost.)
--
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]
