feat: Add ESP_RETURN_ON_ERR macro (IDFGH-14787)

[robotman2412]

Description

This simple macro is a safe way of returning en error code rather than aborting like ESP_ERROR_CHECK would. It is intended to allow future pull requests by myself and/or my friend to replace unnecessary ESP_ERROR_CHECKs with this new ESP_RETURN_ON_ERR macro.

Related

N/A

Testing

This does not involve changing any C files and should not affect any existing code.

---

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.

[CLAassistant]

All committers have signed the CLA.

[github-actions]

	Messages
📖	🎉 Good Job! All checks are passing!

👋 Hello robotman2412, 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.
- 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 981013a

[KonstantinKondrashov]

Thanks for your contribution. LGTM! Just one comment is about renaming and adding an example of usage in the macro description.

[KonstantinKondrashov]

I suggest renaming it as the macros in this file start with ESP_ERROR_CHECK_ . It could be something like ESP_ERROR_RETURN, or ESP_ERROR_CHECK_RETURN.

Additionally, it would be good to have an example of usage. Could you add in the description of the macro how to use it, something like this, I guess:

 * @example
 * esp_err_t get_data()
 * {
 *     ESP_ERROR_CHECK_RETURN(read_file())
 *     ESP_ERROR_CHECK_RETURN(read_file(), close_file())
 *     return ESP_OK;
 * }

[asaitov]

You may want to move your code to esp_check.h or even use an existing macro

esp-idf/components/esp_common/include/esp_check.h

Lines 19 to 25 in 94cfe39

	#define ESP_RETURN_ON_ERROR(x, log_tag, format, ...) do { \
	(void)log_tag; \
	esp_err_t err_rc_ = (x); \
	if (unlikely(err_rc_ != ESP_OK)) { \
	return err_rc_; \
	} \
	} while(0)

[robotman2412]

You may want to move your code to esp_check.h or even use an existing macro

esp-idf/components/esp_common/include/esp_check.h

Lines 19 to 25 in 94cfe39

	#define ESP_RETURN_ON_ERROR(x, log_tag, format, ...) do { \
	(void)log_tag; \
	esp_err_t err_rc_ = (x); \
	if (unlikely(err_rc_ != ESP_OK)) { \
	return err_rc_; \
	} \
	} while(0)

Part of the reason for this PR is that this new macro does not log at all, as opposed to with a menuconfig option. I would be open to moving it to that file if that would get your approval for merging, but I do think it's important to have this non-log variant.

[asaitov]

You may want to move your code to esp_check.h or even use an existing macro

esp-idf/components/esp_common/include/esp_check.h

Lines 19 to 25 in 94cfe39

	#define ESP_RETURN_ON_ERROR(x, log_tag, format, ...) do { \
	(void)log_tag; \
	esp_err_t err_rc_ = (x); \
	if (unlikely(err_rc_ != ESP_OK)) { \
	return err_rc_; \
	} \
	} while(0)

Part of the reason for this PR is that this new macro does not log at all, as opposed to with a menuconfig option. I would be open to moving it to that file if that would get your approval for merging, but I do think it's important to have this non-log variant.

Well, my intention was to make sure you considered the existing macro. I'm fine with having both.

[KonstantinKondrashov]

Hi @robotman2412! I am ok with merging it when it is updated (rename or move to esp_check.h). Thanks.