Skip to content

Fix includes #27

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

Merged
merged 1 commit into from
Aug 2, 2024
Merged

Fix includes #27

merged 1 commit into from
Aug 2, 2024

Conversation

kimkulling
Copy link
Owner

@kimkulling kimkulling commented Aug 2, 2024

Summary by CodeRabbit

  • New Features

    • Improved configuration for building and linking GoogleTest and GoogleMock, supporting better portability between different operating systems.
    • Added flexibility to bypass architecture checks during the build process.
  • Bug Fixes

    • Enhanced consistency in threading support by ensuring pthread support is enabled in the build configuration.
  • Chores

    • Updated paths from Windows-style to Unix-style in configuration files to accommodate a broader range of environments.

Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

The recent changes primarily streamline the CMake configuration for building Google Test and Google Mock. Paths have been adjusted from Windows-style to Unix-style, enhancing portability across environments. Additionally, key flags like pthread support have been enabled, ensuring better consistency and performance. The updates simplify maintenance and clarify the build process without altering existing functionalities.

Changes

Files Change Summary
CMakeLists.txt Modified paths in INCLUDE_DIRECTORIES from absolute to relative for better portability.
contrib/googletest-1.10.x/googletest/generated/GTestConfig.cmake Changed a conditional from if () to if (ON), ensuring unconditioned threading support.
contrib/googletest-1.10.x/googletest/generated/GTestConfigVersion.cmake Introduced a bypass for architecture checks, enhancing configuration flexibility.
contrib/googletest-1.10.x/googletest/generated/gmock.pc, gmock_main.pc, gtest.pc, gtest_main.pc Updated library and include paths from Windows to Unix format; enabled pthread support (-DGTEST_HAS_PTHREAD set to 1).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CMake
    participant GoogleTest
    participant GoogleMock

    User->>CMake: Initiate Build
    CMake->>GoogleTest: Configure Paths
    CMake->>GoogleMock: Configure Paths
    CMake->>GoogleTest: Enable Pthread Support
    CMake->>GoogleMock: Enable Pthread Support
    GoogleTest->>User: Build Complete
    GoogleMock->>User: Build Complete
Loading

Poem

🐇 In fields of code, I hop with glee,
Paths now set, so wild and free!
With pthreads dancing, oh what a sight,
Google Test and Mock, ready for flight!
From Windows’ cage to Unix' grace,
A joyful leap, we quicken the pace! 🌼


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 680eb8c and a51e256.

Files selected for processing (7)
  • CMakeLists.txt (1 hunks)
  • contrib/googletest-1.10.x/googletest/generated/GTestConfig.cmake (1 hunks)
  • contrib/googletest-1.10.x/googletest/generated/GTestConfigVersion.cmake (1 hunks)
  • contrib/googletest-1.10.x/googletest/generated/gmock.pc (1 hunks)
  • contrib/googletest-1.10.x/googletest/generated/gmock_main.pc (1 hunks)
  • contrib/googletest-1.10.x/googletest/generated/gtest.pc (1 hunks)
  • contrib/googletest-1.10.x/googletest/generated/gtest_main.pc (1 hunks)
Files skipped from review due to trivial changes (3)
  • CMakeLists.txt
  • contrib/googletest-1.10.x/googletest/generated/gmock.pc
  • contrib/googletest-1.10.x/googletest/generated/gmock_main.pc
Additional comments not posted (7)
contrib/googletest-1.10.x/googletest/generated/gtest.pc (3)

1-1: LGTM! The libdir change improves portability.

The update from a Windows-specific path to a Unix-style path enhances the portability across Unix-like environments.


2-2: LGTM! The includedir change improves portability.

The update from a Windows-specific path to a Unix-style path enhances the portability across Unix-like environments.


9-9: LGTM! Enabling pthread support is beneficial.

The update to enable pthread support can improve performance and consistency in multi-threaded environments.

contrib/googletest-1.10.x/googletest/generated/gtest_main.pc (3)

1-1: LGTM! The libdir change improves portability.

The update from a Windows-specific path to a Unix-style path enhances the portability across Unix-like environments.


2-2: LGTM! The includedir change improves portability.

The update from a Windows-specific path to a Unix-style path enhances the portability across Unix-like environments.


10-10: LGTM! Enabling pthread support is beneficial.

The update to enable pthread support can improve performance and consistency in multi-threaded environments.

contrib/googletest-1.10.x/googletest/generated/GTestConfig.cmake (1)

27-30: LGTM! Ensuring threading support is always preferred.

The change to make the conditional statement always evaluate to true ensures that threading support is always preferred, which can improve consistency in the build process.

Comment on lines +33 to +36
# if the installed project requested no architecture check, don't perform the check
if("FALSE")
return()
endif()
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the hardcoded condition to make it configurable.

The condition if("FALSE") is hardcoded to always skip the architecture check. This should likely be based on a variable or configuration option to make it configurable.

- if("FALSE")
+ if(NOT DEFINED NO_ARCHITECTURE_CHECK OR NO_ARCHITECTURE_CHECK)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# if the installed project requested no architecture check, don't perform the check
if("FALSE")
return()
endif()
# if the installed project requested no architecture check, don't perform the check
if(NOT DEFINED NO_ARCHITECTURE_CHECK OR NO_ARCHITECTURE_CHECK)
return()
endif()

@kimkulling kimkulling merged commit 08ca910 into master Aug 2, 2024
1 check passed
@kimkulling kimkulling deleted the imkulling/fix_includes branch August 2, 2024 11:58
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