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

esp_tinyuf2: fix nvs hidden key (AEGHB-961) #462

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

Conversation

wormyrocks
Copy link

Description

Allows the use of hidden NVS keys in the uf2 config.ini.
Also fixes an error where NVS entries intended to be hidden would be shown, and entries intended to be shown would be hidden.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

github-actions bot commented Jan 21, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "esp_tinyuf2: fix nvs hidden key":
    • summary looks too short
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]
  • the commit message "include temp fix from github issue 454/ AEGHB-940":
    • probably contains Jira ticket reference (AEGHB-940). Please remove Jira tickets from commit messages.
    • 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).

👋 Hello wormyrocks, we appreciate your contribution to 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.

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 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.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 67a4125

@github-actions github-actions bot changed the title esp_tinyuf2: fix nvs hidden key esp_tinyuf2: fix nvs hidden key (AEGHB-961) Jan 21, 2025
@lijunru-hub
Copy link
Contributor

@wormyrocks LGTM!

@@ -118,7 +118,7 @@ void esp_restart_from_tinyuf2(void);
* @return
* - ESP_OK: Operation was successful.
*/
esp_err_t esp_tinyuf2_set_all_key_hidden(bool if_hidden)
Copy link
Collaborator

Choose a reason for hiding this comment

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

@wormyrocks, is there any difference? Whether there is a formal parameter or not, makes no difference to the function itself.

Copy link
Author

Choose a reason for hiding this comment

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

On my machine it won't compile without this change - something to do with the compiler settings in tinyuf2.
Outside of the include guards, all the other declarations in that file follow the same style.

@leeebo
Copy link
Collaborator

leeebo commented Jan 22, 2025

@wormyrocks thanks for your contribution, It looks great to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants