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

change(MD5Builder): Const-correctness. #9104

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

StefanOberhumer
Copy link
Contributor

Propagate 'const' of underlying esp_rom_md5_update() to MD5Builder::add().
Remove some unneeded methods.

@CLAassistant
Copy link

CLAassistant commented Jan 14, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Jan 14, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Remove char* methods":
    • summary looks empty
    • type/action looks empty
  • the commit message "change(HashBuilder): Const-correctness":
    • summary looks too short
    • scope/component should be lowercase without whitespace, allowed special characters are _ / . , * - .

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 StefanOberhumer, 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 509df6d

@lucasssvaz
Copy link
Collaborator

lucasssvaz commented Jan 16, 2024

The MD5 was changed in #7429. Please take a look if these changes are still needed.

@StefanOberhumer
Copy link
Contributor Author

Yes I think some changes are still needed - as I've changed eg:
void MD5Builder::add(uint8_t * data, uint16_t len);
to
void MD5Builder::add(const uint8_t * data, uint16_t len);

Should I better apply my changes against the sources of #7429 ?

@me-no-dev
Copy link
Member

Should I better apply my changes against the sources of #7429 ?

yes please :) might be easier to start clean, than to fix the conflicts

@StefanOberhumer
Copy link
Contributor Author

Rebased changes atop latest master.

@me-no-dev
Copy link
Member

method is implementation of HashBuilder::add(uint8_t*, size_t), so it needs to be updated there and also in SHA1Builder

@StefanOberhumer
Copy link
Contributor Author

Oooops - Sorry - I missed those changes as I was just focused on that single add() function in the MD5Builder!
I've adapted the PR!

One question - as I'm unsure:
Do we really need
virtual void add(char* data); ( https://github.com/espressif/arduino-esp32/blame/a871518e51ee5494e6ebd987d0a3b75df85cd78c/cores/esp32/HashBuilder.h#L34-L37 )
as we have already
virtual void add(const char* data); ( https://github.com/espressif/arduino-esp32/blame/a871518e51ee5494e6ebd987d0a3b75df85cd78c/cores/esp32/HashBuilder.h#L30-L33 )
in HashBuilder.h ?

Propagate 'const' of buffer variable from underlying functions.
@me-no-dev
Copy link
Member

Do we really need virtual void add(char* data);

No we do not :) I missed it when reviewing. cc @lucasssvaz

@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label Jan 18, 2024
@me-no-dev me-no-dev merged commit 9aae6f5 into espressif:master Jan 19, 2024
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants