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

feat(esp_common): Add ESP_EXIT_ON_ERROR and ESP_EXIT_ON_FALSE macros (IDFGH-12532) #13536

Closed
wants to merge 10 commits into from

Conversation

DCSBL
Copy link
Contributor

@DCSBL DCSBL commented Apr 3, 2024

In our projects, we often use the ESP_RETURN_ON_* macros quite often. However, when the function itself returns void, we encounter limitations in using these macros.

While testing a variant of ESP_EXIT_ON_ERROR, I came across this commit, which suggests that this method was planned. I'm unsure why it didn't make it into the actual code.

Feel free to consider this as a suggestion. If, for some reason, it's not accepted, I'm happy to just use a custom header for our projects.

Copy link

github-actions bot commented Apr 3, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Add ESP_RETURN_VOID_ON_* checks":
    • summary looks empty
    • type/action looks empty
  • the commit message "Add missing _ISR version":
    • summary looks empty
    • type/action looks empty
  • the commit message "Another missing...":
    • summary should not end with a period (full stop)
    • summary looks empty
    • type/action looks empty
  • the commit message "Apply suggestions from code review":
    • summary looks empty
    • type/action looks empty
  • the commit message "Final whitespaces":
    • summary looks empty
    • type/action looks empty
  • the commit message "Remove extra whiteline":
    • summary looks empty
    • type/action looks empty
  • the commit message "Rename macros to ESP_EXIT_ON_*":
    • summary looks empty
    • type/action looks empty
  • the commit message "Some more cleanups":
    • summary looks empty
    • type/action looks empty
  • the commit message "Sort and add _ISR version":
    • summary looks empty
    • type/action looks empty
  • the commit message "You guassed it..":
    • summary should not end with a period (full stop)
    • summary looks empty
    • type/action looks empty

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

⚠️ Please consider squashing your 10 commits (simplifying branch history).

👋 Hello DCSBL, 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 66550fa

DCSBL

This comment was marked as outdated.

@DCSBL DCSBL changed the title Add ESP_EXIT_ON_ERROR and ESP_EXIT_ON_FALSE macros feat(esp_common): Add ESP_EXIT_ON_ERROR and ESP_EXIT_ON_FALSE macros Apr 3, 2024
@DCSBL DCSBL marked this pull request as ready for review April 3, 2024 09:23
@espressif-bot espressif-bot added the Status: Opened Issue is new label Apr 3, 2024
@github-actions github-actions bot changed the title feat(esp_common): Add ESP_EXIT_ON_ERROR and ESP_EXIT_ON_FALSE macros feat(esp_common): Add ESP_EXIT_ON_ERROR and ESP_EXIT_ON_FALSE macros (IDFGH-12532) Apr 3, 2024
@KonstantinKondrashov
Copy link
Collaborator

Hi @DCSBL!
LGTM!
Thanks for your contribution. I took it into the internal repo, this PR will be closed once the review and merge is completed.

@espressif-bot espressif-bot added Status: Reviewing Issue is being reviewed and removed Status: Opened Issue is new labels Apr 9, 2024
@DCSBL
Copy link
Contributor Author

DCSBL commented Apr 9, 2024

Awesome 👍

@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Reviewing Issue is being reviewed labels Apr 11, 2024
espressif-bot pushed a commit that referenced this pull request Apr 17, 2024
@Alvin1Zhang
Copy link
Collaborator

Thanks for contribution again, changes have been merged with 69f6170.

@Alvin1Zhang Alvin1Zhang closed this May 7, 2024
@DCSBL DCSBL deleted the patch-1 branch May 7, 2024 08:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Resolution: NA Issue resolution is unavailable Status: Done Issue is done internally
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants