Skip to content
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.

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

Improve rerun_cpp readme & CMakeLists.txt #4126

Merged
merged 15 commits into from Nov 3, 2023
Merged

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Nov 2, 2023

What

  • Fixes Improve rerun_cpp readme.md and add it to the rerun_cpp_sdk.zip file #4117
  • overhauled Readme.md for rerun_cpp
  • everything except is now part of rerun_cpp zip bundle
  • made rerun_cpp CMakeLists.txt smaller by splitting out the from-source rerun_c and the from-source arrow builds out
  • rerun_c is now built as a built action, meaning it's part of the buildgraph of whatever generator you use - e.g. Ninja will build it now in parallel to your C files 🥳

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation 🧑‍💻 dev experience developer experience (excluding CI) 🌊 C++ API C or C++ logging API include in changelog labels Nov 2, 2023
@Wumpf
Copy link
Member Author

Wumpf commented Nov 2, 2023

uh. needs windows fixing. Why am I not surprised

@Wumpf
Copy link
Member Author

Wumpf commented Nov 2, 2023

There was more wrong than just windows build. Had to kill the path of being in the repo and still setting RERUN_C_LIB cmake config variable. Realistically we don't need it and this makes things easier

Copy link
Member

@jleibs jleibs left a comment

Choose a reason for hiding this comment

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

Overall looks great. Splitting out the arrow stuff makes the CMakeLists.txt much more approachable.

rerun_cpp/CMakeLists.txt Outdated Show resolved Hide resolved
# Hack to propagate INTERFACE_INCLUDE_DIRECTORIES.
# via https://stackoverflow.com/a/47358004
file(MAKE_DIRECTORY ${ARROW_DOWNLOAD_PATH}/include)
include(download_and_build_arrow.cmake)
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

tbh I'm deeply confused (and troubled) about the visibility scope of cmake variables, so I don't know. Worst case this requires more patches then

rerun_cpp/README.md Outdated Show resolved Hide resolved
@Wumpf Wumpf merged commit c62c6a3 into main Nov 3, 2023
40 checks passed
@Wumpf Wumpf deleted the andreas/cpp/better-readme branch November 3, 2023 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌊 C++ API C or C++ logging API 🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve rerun_cpp readme.md and add it to the rerun_cpp_sdk.zip file
2 participants