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(esp32): Removed rogue semicolon in #define in esp_smartconfig.h (IDFGH-11769) #12867

Closed
wants to merge 1 commit into from

Conversation

howroyd
Copy link
Contributor

@howroyd howroyd commented Dec 24, 2023

Removed rogue semicolon in the #define for default Smartconfig config.

This semicolon is not congruent with the Wifi default config.

Mainly, it does not play nice with C++ brace initialisation, for example:

struct S
{
    std::unique_ptr<smartconfig_start_config_t> cfg;

    x() : cfg(new smartconfig_start_config_t(SMARTCONFIG_START_CONFIG_DEFAULT()))
    {}
};

Produces a compiler error due to the semicolon placed in by the preprocessor text substitution.

However, similar useful code for Wifi works fine since there is no semicolon in the define here, for example:

struct S
{
    std::unique_ptr<wifi_init_config_t> cfg;

    x() : cfg(new wifi_init_config_t(WIFI_INIT_CONFIG_DEFAULT()))
    {}
};

Is fine.

Removed rogue semicolon in `#define`
@CLAassistant
Copy link

CLAassistant commented Dec 24, 2023

CLA assistant check
All committers have signed the CLA.

Copy link

github-actions bot commented Dec 24, 2023

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Update esp_smartconfig.h":
    • 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
  • 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 howroyd, 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 a1b1d74

@howroyd howroyd changed the title Removed rogue semicolon in #define in esp_smartconfig.h fix(esp32): Removed rogue semicolon in #define in esp_smartconfig.h Dec 24, 2023
@espressif-bot espressif-bot added the Status: Opened Issue is new label Dec 24, 2023
@github-actions github-actions bot changed the title fix(esp32): Removed rogue semicolon in #define in esp_smartconfig.h fix(esp32): Removed rogue semicolon in #define in esp_smartconfig.h (IDFGH-11769) Dec 24, 2023
Copy link
Collaborator

@Dazza0 Dazza0 left a comment

Choose a reason for hiding this comment

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

@howroyd Thanks for the PR. Changes LGTM

@Dazza0 Dazza0 added the PR-Sync-Rebase Pull request sync as rebase commit label Feb 5, 2024
@Dazza0
Copy link
Collaborator

Dazza0 commented Feb 5, 2024

sha=a1b1d745dc5e2ec01e7706a88b9cf76262491ad5

@espressif-bot espressif-bot added Status: Done Issue is done internally Resolution: NA Issue resolution is unavailable and removed Status: Opened Issue is new labels Feb 6, 2024
@howroyd howroyd deleted the patch-1 branch February 9, 2024 09:22
espressif-bot pushed a commit that referenced this pull request Mar 1, 2024
Removed rogue semicolon from SMARTCONFIG_START_CONFIG_DEFAULT() macro. This
fixes build issues when this macro is used via C++ brace initialization.

Closes #12867

[Darian Leung: Updated commit message]
Signed-off-by: Darian Leung <darian@espressif.com>
espressif-bot pushed a commit that referenced this pull request Mar 5, 2024
Removed rogue semicolon from SMARTCONFIG_START_CONFIG_DEFAULT() macro. This
fixes build issues when this macro is used via C++ brace initialization.

Closes #12867

[Darian Leung: Updated commit message]
Signed-off-by: Darian Leung <darian@espressif.com>
espressif-bot pushed a commit that referenced this pull request Mar 13, 2024
Removed rogue semicolon from SMARTCONFIG_START_CONFIG_DEFAULT() macro. This
fixes build issues when this macro is used via C++ brace initialization.

Closes #12867

[Darian Leung: Updated commit message]
Signed-off-by: Darian Leung <darian@espressif.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR-Sync-Rebase Pull request sync as rebase commit 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.

None yet

4 participants