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

fix: Change preference name from CMake cache to Ccache #936

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

kolipakakondal
Copy link
Collaborator

@kolipakakondal kolipakakondal commented Apr 17, 2024

Description

Changed preference name from CMake cache to Ccache and improved the tooltip message

Fixes # (IEP-1205)

Type of change

  • Bug fix (non-breaking change which fixes an issue)

How has this been tested?

  • Open Espressif preferences
  • Verify that preferences name changed from Enable CMake cache to Enable Ccache

Test Configuration:

  • ESP-IDF Version: 5.1
  • OS (Windows,Linux and macOS): macOS

Dependent components impacted by this PR:

  • Preferences

Checklist

  • PR Self Reviewed
  • Applied Code formatting
  • Added Documentation
  • Added Unit Test
  • Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

  • Documentation
    • Updated tooltip and label for enabling CCache in the IDF CMake build to clarify the requirement of installing the CCache tool and enhance consistency.

Copy link

coderabbitai bot commented Apr 17, 2024

Walkthrough

The update enhances the user interface for the IDF Eclipse plugin by refining the tooltip and label associated with the CCache configuration in the IDF CMake build, making the requirement for CCache tool installation clearer and improving consistency in terminology.

Changes

File Path Change Summary
.../idf.ui/.../messages.properties Updated tooltip and label for CCache configuration in IDF CMake build.

Possibly related issues

Poem

🐰✨
In a land of code and compile,
A small change makes a big smile.
Tooltip refined, clarity's new friend,
With CCache checked, faster builds send.
Hop, hop, hurray, let the coding extend!
🌟🐇


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4fd103c and 91abb21.
Files selected for processing (1)
  • bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/preferences/messages.properties (1 hunks)
Additional comments not posted (1)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/preferences/messages.properties (1)

3-3: Label change is accurate and improves clarity.


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration 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

@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

@@ -1,6 +1,6 @@
EspresssifPreferencesPage_BuildGroupTxt=Build Settings
EspresssifPreferencesPage_CCacheToolTip=This sets CCACHE_ENABLE=1 to the IDF CMake build
EspresssifPreferencesPage_EnableCCache=Enable CMake cache
EspresssifPreferencesPage_CCacheToolTip=This sets CCACHE_ENABLE=1 to the IDF CMake build, if the CCache tool is installed
Copy link

Choose a reason for hiding this comment

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

Tooltip update aligns well with the PR objectives.

Consider adding "if installed" at the end of the tooltip for clarity:

- This sets CCACHE_ENABLE=1 to the IDF CMake build, if the CCache tool is installed
+ This sets CCACHE_ENABLE=1 to the IDF CMake build, if the CCache tool is installed if installed.

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.

Suggested change
EspresssifPreferencesPage_CCacheToolTip=This sets CCACHE_ENABLE=1 to the IDF CMake build, if the CCache tool is installed
EspresssifPreferencesPage_CCacheToolTip=This sets CCACHE_ENABLE=1 to the IDF CMake build, if the CCache tool is installed if installed.

@kolipakakondal kolipakakondal merged commit 04526e6 into master Apr 23, 2024
2 of 5 checks passed
@kolipakakondal kolipakakondal deleted the IEP-1205 branch April 23, 2024 09:28
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.

1 participant