Skip to content

Update cmake instructions in README #24

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

Closed
wants to merge 1 commit into from
Closed

Update cmake instructions in README #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# under the License.

build/
install/
Copy link
Collaborator

@zhjwpku zhjwpku Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this? Is this generated by some IDE?

Copy link
Member Author

@zuyu zuyu Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, since we specify CMAKE_INSTALL_PREFIX in cmake, I think someone might specify CMAKE_INSTALL_PREFIX=install in the repo directory as well.

Copy link
Collaborator

@zhjwpku zhjwpku Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, since we specify CMAKE_INSTALL_PREFIX in cmake, I think someone might specify CMAKE_INSTALL_PREFIX=install in the repo directory as well.

I doubt anyone would do this, if you really need to install in src tree, you can specify CMAKE_INSTALL_PREFIX=/build/install.

cmake-build-debug/
cmake-build-release/
.DS_Store
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ C++ implementation of [Apache Iceberg™](https://iceberg.apache.org/).

```bash
cd iceberg-cpp
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=/path/to/install -DICEBERG_BUILD_STATIC=ON -DICEBERG_BUILD_SHARED=ON
cmake -S . -B build -DCMAKE_INSTALL_PREFIX=/path/to/install -DICEBERG_BUILD_STATIC=ON -DICEBERG_BUILD_SHARED=ON -DICEBERG_BUILD_TESTS=OFF -DICEBERG_ARROW=OFF
Copy link
Collaborator

@zhjwpku zhjwpku Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe these options should be documented somewhere but not specified in the same example command?

Copy link
Member

@wgtmac wgtmac Jan 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. An official site for iceberg-cpp is more suitable for these documentations.

Copy link
Member

@lidavidm lidavidm Jan 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we open an issue to choose a documentation/site generator?

Copy link
Member

@wgtmac wgtmac Jan 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good if someone with expertise could lead this :)

Copy link
Member

@lidavidm lidavidm Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#26

Copy link
Member Author

@zuyu zuyu Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is to update cmake to build Core Libraries, and I think we don't need to build Arrow for the core libraries, right?

cmake --build build
cmake --install build
```
Expand Down
Loading