This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 0bdb5be03d GH-43998: [C++][Docs] Add missing install command in
building docs (#44000)
0bdb5be03d is described below
commit 0bdb5be03da62de750d3def1a2716536b791b50d
Author: Sutou Kouhei <[email protected]>
AuthorDate: Fri Sep 13 11:24:37 2024 +0900
GH-43998: [C++][Docs] Add missing install command in building docs (#44000)
### Rationale for this change
We need to install to use built Arrow C++ in our application.
### What changes are included in this PR?
Add an install command line for each build command lines.
### Are these changes tested?
Yes.
### Are there any user-facing changes?
Yes.
* GitHub Issue: #43998
Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
---
docs/source/developers/cpp/building.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/source/developers/cpp/building.rst
b/docs/source/developers/cpp/building.rst
index b052b856c9..60a9e06941 100644
--- a/docs/source/developers/cpp/building.rst
+++ b/docs/source/developers/cpp/building.rst
@@ -213,6 +213,8 @@ and then ask to compile the build targets:
0 directories, 3 files
+ $ cmake --install .
+
When creating a build, it is possible to pass custom options besides
the preset-defined ones, for example:
@@ -293,6 +295,7 @@ Minimal release build (1GB of RAM for building or more
recommended):
$ cd build-release
$ cmake ..
$ make -j8 # if you have 8 CPU cores, otherwise adjust
+ $ make install
Minimal debug build with unit tests (4GB of RAM for building or more
recommended):
@@ -305,6 +308,7 @@ Minimal debug build with unit tests (4GB of RAM for
building or more recommended
$ cmake -DCMAKE_BUILD_TYPE=Debug -DARROW_BUILD_TESTS=ON ..
$ make -j8 # if you have 8 CPU cores, otherwise adjust
$ make unittest # to run the tests
+ $ make install
The unit tests are not built by default. After building, one can also invoke
the unit tests using the ``ctest`` tool provided by CMake (note that ``test``
