Skip to content

GH-47157: [Docs] Improve presentation of Other available packages section in build_system.rst #47411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amoeba merged 4 commits into from
Aug 28, 2025
+25 −27
Merged

GH-47157: [Docs] Improve presentation of Other available packages section in build_system.rst #47411

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5a00b71
GH-47157: [Docs] Improve presentation of Other available packages sec…
vidhyarbiji Aug 22, 2025
313e719
Update Other available packages section in docs/source/cpp/build_syst…
vidhyarbiji Aug 28, 2025
441f7a2
Update Other available packages section in docs/source/cpp/build_syst…
vidhyarbiji Aug 28, 2025
6e8b174
Update Other available packages section in docs/source/cpp/build_syst…
vidhyarbiji Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 25 additions & 27 deletions docs/source/cpp/build_system.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,33 +111,31 @@ Other available packages

There are other available packages, they can also be used with the `find_package
<https://cmake.org/cmake/help/latest/command/find_package.html>`_ directive.
This is the list of available ones and the respective targets created:

+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| find_package usage | shared target | static target |
+===============================================+========================================================+=====================================================+
| ``find_package(ArrowCUDA REQUIRED)`` | ``ArrowCUDA::arrow_cuda_shared`` | ``ArrowCUDA::arrow_cuda_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowAcero REQUIRED)`` | ``ArrowAcero::arrow_acero_shared`` | ``ArrowAcero::arrow_acero_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowCompute REQUIRED)`` | ``ArrowCompute::arrow_compute_shared`` | ``ArrowCompute::arrow_compute_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowDataset REQUIRED)`` | ``ArrowDataset::arrow_dataset_shared`` | ``ArrowDataset::arrow_dataset_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowFlight REQUIRED)`` | ``ArrowFlight::arrow_flight_shared`` | ``ArrowFlight::arrow_flight_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowFlightSql REQUIRED)`` | ``ArrowFlightSql::arrow_flight_sql_shared`` | ``ArrowFlightSql::arrow_flight_sql_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowFlightTesting REQUIRED)`` | ``ArrowFlightTesting::arrow_flight_testing_shared`` | ``ArrowFlightTesting::arrow_flight_testing_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowSubstrait REQUIRED)`` | ``ArrowSubstrait::arrow_substrait_shared`` | ``ArrowSubstrait::arrow_substrait_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(ArrowTesting REQUIRED)`` | ``ArrowTesting::arrow_testing_shared`` | ``ArrowTesting::arrow_testing_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(Gandiva REQUIRED)`` | ``Gandiva::gandiva_shared`` | ``Gandiva::gandiva_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
| ``find_package(Parquet REQUIRED)`` | ``Parquet::parquet_shared`` | ``Parquet::parquet_static`` |
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
This is the list of available packages:

* ArrowCUDA
* ArrowAcero
* ArrowCompute
* ArrowDataset
* ArrowFlight
* ArrowFlightSql
* ArrowFlightTesting
* ArrowSubstrait
* ArrowTesting
* Gandiva
* Parquet

Usage with find_package and target names follows a consistent naming pattern:

* find_package usage: ``find_package(PackageName REQUIRED)``
* Shared Target: ``PackageName::package_name_shared``
* Static Target: ``PackageName::package_name_static``

For example, to use the ``ArrowCompute`` package:

* find_package Usage: ``find_package(ArrowCompute REQUIRED)``
* Shared Target: ``ArrowCompute::arrow_compute_shared``
* Static Target: ``ArrowCompute::arrow_compute_static``

.. note::
CMake is case-sensitive. The names and variables listed above have to be
Expand Down
Loading