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

Allow using other CMake generators besides "Unix Makefiles". #19

Merged
merged 1 commit into from
Oct 6, 2024

Conversation

junhaoliao
Copy link
Member

@junhaoliao junhaoliao commented Oct 5, 2024

Description

Previously, it was mandated in CMakeList.txt that only Unix Makefiles generators can be used because compilation errors were observed with code that references C++-20 headers. It is confirmed that now with Ninja generators, the clp-ffi-js code compiles fine with Emsdk @ 3.1.67 .

  1. Remove "Unix Makefiles" CMAKE_GENERATOR check.
  2. Eliminate the generator specification from compilation commands in Taskfile.

Validation performed

  1. On a Mac computer.
    1. Ran task clp-ffi-js and observed compilation success.
    2. Added a semantically meaningless newline at the end of StreamReader.cpp and ran task clp-ffi-js again. Observed the source code getting compiled and the overall compilation succeeded.
  2. On an Ubuntu 20.04 computer, repeat above validation steps. (In my case, I was using WSL. )

Summary by CodeRabbit

  • New Features
    • Simplified build configuration by allowing various generators without restrictions.
    • Introduced new variables in task definitions for improved build clarity and reliability.
  • Bug Fixes
    • Enhanced handling of the Boost library version for better compatibility.
  • Chores
    • Updated task commands to ensure a clean build environment and consistent checksum validation.

…tor specification from compilation commands in Taskfile.
Copy link

coderabbitai bot commented Oct 5, 2024

Walkthrough

The changes in this pull request primarily involve modifications to the CMakeLists.txt and Taskfile.yml files for the clp-ffi-js project. The CMakeLists.txt file removes a restriction on the build generator, allowing for more flexibility in build configurations. Additionally, it updates the Boost library version and ensures compatibility with newer CMake versions. The Taskfile.yml file reflects similar adjustments, including the removal of the generator option in the cmake command, the introduction of new variables for versioning, and refinements to task dependencies.

Changes

File Change Summary
CMakeLists.txt Removed the conditional check for "Unix Makefiles" generator; updated Boost library version to "1.85.0"; ensured compatibility with CMake 3.24+; maintained existing configurations for executable name and linker flags.
Taskfile.yml Removed -G "Unix Makefiles" from cmake command; added EMSDK_VERSION variable set to "3.1.67"; updated CHECKSUM_FILE and OUTPUT_DIR variables in package task; refined task dependencies for checksum validation.

Possibly related PRs

Suggested reviewers

  • davemarco

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3457e37 and 709fc81.

📒 Files selected for processing (2)
  • CMakeLists.txt (0 hunks)
  • Taskfile.yml (0 hunks)
💤 Files with no reviewable changes (2)
  • CMakeLists.txt
  • Taskfile.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@junhaoliao
Copy link
Member Author

junhaoliao commented Oct 5, 2024

This PR shall merge from main once #18 is merged into main.

Copy link
Member

@kirkrodrigues kirkrodrigues left a comment

Choose a reason for hiding this comment

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

For the PR title, how about:

Allow using other CMake generators besides "Unix Makefiles".

@junhaoliao junhaoliao changed the title Remove "Unix Makefiles" CMAKE_GENERATOR check; Eliminate the generator specification from compilation commands in Taskfile. Allow using other CMake generators besides "Unix Makefiles". Oct 6, 2024
@junhaoliao junhaoliao merged commit 0ca63a2 into y-scope:main Oct 6, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants