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

refactor(components/fatfs): replace assert expression (IDFGH-14473) #15247

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

safocl
Copy link

@safocl safocl commented Jan 21, 2025

assert expressions in the diskio_wl.c file contains a magical calculations. This PR replaces them with an equality check.

before:
assert(wl_handle + 1);
after:
assert(wl_handle != WL_INVALID_HANDLE);

Related

Fixes #15246


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.

assert expressions in the diskio_wl.c file contains a magical calculations.
This PR replaces them with an equality check.
Copy link

github-actions bot commented Jan 21, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "rew(components/fatfs): replace assert expression":
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]
    • body must have leading blank line

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).

Messages
📖 You might consider squashing your 3 commits (simplifying branch history).

👋 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.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- 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 27cf212

@safocl safocl changed the title rew(components/fatfs): replace assert expression refactor(components/fatfs): replace assert expression Jan 21, 2025
@espressif-bot espressif-bot added the Status: Opened Issue is new label Jan 21, 2025
@github-actions github-actions bot changed the title refactor(components/fatfs): replace assert expression refactor(components/fatfs): replace assert expression (IDFGH-14473) Jan 21, 2025
assert expressions in the diskio_wl.c file contains a magical calculations.
This PR replaces them with an equality check.
assert expressions in the diskio_wl.c file contains a magical calculations.
This PR replaces them with an equality check.
(error corrected)
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.

rewrite(components/fatfs): use constant instead number (IDFGH-14472)
4 participants