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

breaking: drop C++ 11 #4068

Merged
merged 2 commits into from
Aug 21, 2024
Merged

breaking: drop C++ 11 #4068

merged 2 commits into from
Aug 21, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 20, 2024

Fix #4060.

Summary by CodeRabbit

  • Documentation

    • Updated installation documentation to clarify C++ compiler requirements, specifying that GCC 5 or higher is necessary for C++ 14 and potentially GCC 7 for C++ 17.
  • Chores

    • Enhanced CMake configuration to support C++ 14 in specific scenarios, improving compatibility with older codebases.

@github-actions github-actions bot added the Docs label Aug 20, 2024
Copy link
Contributor

coderabbitai bot commented Aug 20, 2024

Walkthrough

Walkthrough

The recent updates to the DeePMD-kit documentation and build configuration clarify the C++ compiler requirements for installation. The documentation now specifies that GCC 5 or higher is required to support C++ 14, with potential needs for GCC 7 for C++ 17 due to backend packages. Additionally, the CMake configuration has been modified to conditionally set the C++ standard to 14 when linking to a specific C library, enhancing compatibility.

Changes

Files Change Summary
doc/install/install-from-source.md, source/CMakeLists.txt Updated documentation to clarify C++ compiler requirements, specifying GCC 5 for C++ 14 and GCC 7 for C++ 17; modified CMake to conditionally set C++ standard to 14 when DEEPMD_C_ROOT is undefined.

Assessment against linked issues

Objective Addressed Explanation
Drop C++ 11 support (#[4060])
Allow C++ 14 in the codebase

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d77c075 and a1a8698.

Files selected for processing (2)
  • doc/install/install-from-source.md (1 hunks)
  • source/CMakeLists.txt (1 hunks)
Additional comments not posted (2)
source/CMakeLists.txt (1)

19-22: Ensure C++ 14 is correctly set when DEEPMD_C_ROOT is not defined.

The conditional logic to set the C++ standard to 14 when DEEPMD_C_ROOT is not defined seems appropriate. This aligns with the PR's objective of dropping C++ 11 support. Ensure that this change does not inadvertently affect other parts of the build configuration.

Run the following script to verify the impact of the conditional setting of the C++ standard:

Verification successful

C++ Standard Setting Verified

The set_if_higher macro ensures that the C++ standard is set to 14 only if it is currently lower, preventing any unintended overrides. This conditional logic is correctly implemented and aligns with the PR's objectives. No further issues are found regarding the C++ standard setting.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that the C++ standard is set correctly in all relevant CMakeLists.txt files.

# Test: Search for CMAKE_CXX_STANDARD settings. Expect: Correct conditional settings.
rg --type cmake -A 2 'set\(CMAKE_CXX_STANDARD'

Length of output: 843


Script:

#!/bin/bash
# Search for the definition of the set_if_higher macro to understand its behavior.
rg --type cmake 'macro\(set_if_higher'

Length of output: 98


Script:

#!/bin/bash
# Extract the complete implementation of the set_if_higher macro from source/CMakeLists.txt.
rg --type cmake -A 10 'macro\(set_if_higher' source/CMakeLists.txt

Length of output: 375

doc/install/install-from-source.md (1)

111-112: Clarify C++ compiler requirements for users.

The documentation now specifies that C++ 14 is the default standard, requiring GCC 5 or later. It also mentions that backend packages might require C++ 17, necessitating GCC 7. This update is clear and aligns with the changes in the codebase. Ensure users are aware of these requirements to avoid compatibility issues.


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.

@njzjz njzjz linked an issue Aug 20, 2024 that may be closed by this pull request
Copy link

codecov bot commented Aug 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.95%. Comparing base (d77c075) to head (a1a8698).
Report is 175 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #4068   +/-   ##
=======================================
  Coverage   82.95%   82.95%           
=======================================
  Files         522      522           
  Lines       51044    51045    +1     
  Branches     3031     3028    -3     
=======================================
+ Hits        42341    42342    +1     
+ Misses       7759     7757    -2     
- Partials      944      946    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Aug 21, 2024
Merged via the queue into deepmodeling:devel with commit 560c7df Aug 21, 2024
60 checks passed
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
Fix deepmodeling#4060.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Updated installation documentation to clarify C++ compiler
requirements, specifying that GCC 5 or higher is necessary for C++ 14
and potentially GCC 7 for C++ 17.
  
- **Chores**
- Enhanced CMake configuration to support C++ 14 in specific scenarios,
improving compatibility with older codebases.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@njzjz njzjz added the breaking change Breaking changes that should notify users. label Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Breaking changes that should notify users. Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Drop C++ 11?
2 participants