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(storage/fatfs): Compiler unused warnings (IDFGH-14289) #15081

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

safocl
Copy link

@safocl safocl commented Dec 23, 2024

Description

Some variables inserted to asserts, but it produce the warning reports with CONFIG_COMPILER_ASSERT_NDEBUG_EVALUATE=n :

esp-idf/components/fatfs/diskio/diskio_rawflash.c warning: unused variable 'part' [-Wunused-variable]
   XX |     const esp_partition_t* part = s_ff_raw_handles[pdrv];
      |                            ^~~~
esp-idf/components/fatfs/vfs/vfs_fat_sdmmc.c warning: unused variable 'found' [-Wunused-variable]
  XXX |     bool found = s_get_context_id_by_card(card, &id);
      |          ^~~~~

This PR fix it (remove temporary unused variables).

Checklist

Before submitting a Pull Request, please ensure the following:

  • 🚨 This PR does not introduce breaking changes.
  • All CI checks (GH Actions) pass.
  • Documentation is updated as needed.
  • Tests are updated or added as necessary.
  • Code is well-commented, especially in complex areas.
  • Git history is clean — commits are squashed to the minimum necessary.

Upd:
6326508 fix

esp-idf/components/driver/twai/twai.c warning: unused variable 'res' [-Wunused-variable]
  XXX |     bool res = twai_hal_init(&p_twai_obj->hal, &hal_config);
      |          ^

Copy link

github-actions bot commented Dec 23, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "fix(storage/fatfs): Compiler unused warning":
    • body's lines must not be longer than 100 characters

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello safocl, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests via this public GitHub repository.

This GitHub project is public mirror of our internal git repository

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved, we synchronize it into our internal git repository.
4. In the internal git repository we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
5. If the change is approved and passes the tests it is merged into the default branch.
5. On next sync from the internal git repository merged change will appear in this public GitHub repository.

Generated by 🚫 dangerJS against 4da9b86

@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 23, 2024
@github-actions github-actions bot changed the title fix(components): Compiler reports some warnings fix(components): Compiler reports some warnings (IDFGH-14289) Dec 23, 2024
@haberturdeur
Copy link
Collaborator

haberturdeur commented Jan 29, 2025

Hi, thank you for the contribution!

Left a small note regarding the code.

Could you please also clean-up the commit history to only have the one commit with changes.
Thank you.

@safocl
Copy link
Author

safocl commented Jan 29, 2025

Could you please also clean-up the commit history to only have the one commit with changes. Thank you.

what's the best way to do that?

@safocl safocl force-pushed the safocl_dev2 branch 2 times, most recently from 63d7790 to 0b8d98d Compare January 29, 2025 18:34
@safocl safocl requested a review from haberturdeur January 29, 2025 18:35
@safocl safocl force-pushed the safocl_dev2 branch 2 times, most recently from f559b7c to d69d767 Compare January 30, 2025 10:17
@safocl safocl requested a review from haberturdeur January 30, 2025 10:18
@haberturdeur
Copy link
Collaborator

Again, thank you for the contribution!

Just a note, it might take a few days to get through our internal process and propagate back to github.

@safocl
Copy link
Author

safocl commented Jan 30, 2025

Again, thank you for the contribution!

Just a note, it might take a few days to get through our internal process and propagate back to github.

I think this is definitely needed -- any changes should be tested as thoroughly as possible (everyone can make mistakes)

@haberturdeur
Copy link
Collaborator

Hi, sorry, but one more change is needed.

Could you please modify the commit message fit the required format

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter

Something along the lines of fix(storage/fatfs): Compiler unused warnings for the summary.

Thank you.

esp-idf/components/fatfs/diskio/diskio_rawflash.c warning: unused variable 'part' [-Wunused-variable]
   XX |     const esp_partition_t* part = s_ff_raw_handles[pdrv];
      |                            ^~~~
esp-idf/components/fatfs/vfs/vfs_fat_sdmmc.c warning: unused variable 'found' [-Wunused-variable]
  XXX |     bool found = s_get_context_id_by_card(card, &id);
      |          ^~~~~
@safocl safocl changed the title fix(components): Compiler reports some warnings (IDFGH-14289) fix(storage/fatfs): Compiler unused warnings (IDFGH-14289) Jan 31, 2025
@safocl safocl requested a review from haberturdeur January 31, 2025 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Opened Issue is new
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants