Skip to content

Commit ed77d25

Browse files
vidhyarbijiamoeba
andauthored
GH-47157: [Docs] Improve presentation of Other available packages section in build_system.rst (#47411)
### Rationale for this change The table in the "Other available packages" section of build_system.rst was refactored for improved readability. ### What changes are included in this PR? Refactored the table in the "Other available packages" section of build_system.rst ### Are these changes tested? Verified the preview of docs ### Are there any user-facing changes? No. * GitHub Issue: #47157 Lead-authored-by: Vidhya Ravikumar <[email protected]> Co-authored-by: vidhya.ravikumar <[email protected]> Co-authored-by: Bryce Mecum <[email protected]> Signed-off-by: Bryce Mecum <[email protected]>
1 parent a4cde2c commit ed77d25

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

docs/source/cpp/build_system.rst

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -111,33 +111,31 @@ Other available packages
111111

112112
There are other available packages, they can also be used with the `find_package
113113
<https://cmake.org/cmake/help/latest/command/find_package.html>`_ directive.
114-
This is the list of available ones and the respective targets created:
115-
116-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
117-
| find_package usage | shared target | static target |
118-
+===============================================+========================================================+=====================================================+
119-
| ``find_package(ArrowCUDA REQUIRED)`` | ``ArrowCUDA::arrow_cuda_shared`` | ``ArrowCUDA::arrow_cuda_static`` |
120-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
121-
| ``find_package(ArrowAcero REQUIRED)`` | ``ArrowAcero::arrow_acero_shared`` | ``ArrowAcero::arrow_acero_static`` |
122-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
123-
| ``find_package(ArrowCompute REQUIRED)`` | ``ArrowCompute::arrow_compute_shared`` | ``ArrowCompute::arrow_compute_static`` |
124-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
125-
| ``find_package(ArrowDataset REQUIRED)`` | ``ArrowDataset::arrow_dataset_shared`` | ``ArrowDataset::arrow_dataset_static`` |
126-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
127-
| ``find_package(ArrowFlight REQUIRED)`` | ``ArrowFlight::arrow_flight_shared`` | ``ArrowFlight::arrow_flight_static`` |
128-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
129-
| ``find_package(ArrowFlightSql REQUIRED)`` | ``ArrowFlightSql::arrow_flight_sql_shared`` | ``ArrowFlightSql::arrow_flight_sql_static`` |
130-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
131-
| ``find_package(ArrowFlightTesting REQUIRED)`` | ``ArrowFlightTesting::arrow_flight_testing_shared`` | ``ArrowFlightTesting::arrow_flight_testing_static`` |
132-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
133-
| ``find_package(ArrowSubstrait REQUIRED)`` | ``ArrowSubstrait::arrow_substrait_shared`` | ``ArrowSubstrait::arrow_substrait_static`` |
134-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
135-
| ``find_package(ArrowTesting REQUIRED)`` | ``ArrowTesting::arrow_testing_shared`` | ``ArrowTesting::arrow_testing_static`` |
136-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
137-
| ``find_package(Gandiva REQUIRED)`` | ``Gandiva::gandiva_shared`` | ``Gandiva::gandiva_static`` |
138-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
139-
| ``find_package(Parquet REQUIRED)`` | ``Parquet::parquet_shared`` | ``Parquet::parquet_static`` |
140-
+-----------------------------------------------+--------------------------------------------------------+-----------------------------------------------------+
114+
This is the list of available packages:
115+
116+
* ArrowCUDA
117+
* ArrowAcero
118+
* ArrowCompute
119+
* ArrowDataset
120+
* ArrowFlight
121+
* ArrowFlightSql
122+
* ArrowFlightTesting
123+
* ArrowSubstrait
124+
* ArrowTesting
125+
* Gandiva
126+
* Parquet
127+
128+
Usage with find_package and target names follows a consistent naming pattern:
129+
130+
* find_package usage: ``find_package(PackageName REQUIRED)``
131+
* Shared Target: ``PackageName::package_name_shared``
132+
* Static Target: ``PackageName::package_name_static``
133+
134+
For example, to use the ``ArrowCompute`` package:
135+
136+
* find_package Usage: ``find_package(ArrowCompute REQUIRED)``
137+
* Shared Target: ``ArrowCompute::arrow_compute_shared``
138+
* Static Target: ``ArrowCompute::arrow_compute_static``
141139

142140
.. note::
143141
CMake is case-sensitive. The names and variables listed above have to be

0 commit comments

Comments
 (0)