Skip to content

buffer log, compile time dispatched#6

Merged
erhankur merged 2 commits intoespressif:masterfrom
antmak:feat/log_buf
Apr 30, 2025
Merged

buffer log, compile time dispatched#6
erhankur merged 2 commits intoespressif:masterfrom
antmak:feat/log_buf

Conversation

@antmak
Copy link
Collaborator

@antmak antmak commented Apr 15, 2025

  • moves STUB_LOG_ENABLED into esp-stub-lib again -- to have common interface for dispatching log configuration

  • allows the compile time log configuration dispatching. Nothing extra in the binary result

  • to enable: pass STUB_LOG_ENABLED via STUB_COMPILE_DEFS

  • to switch logger type: pass STUB_LIB_LOG_BUF or STUB_LIB_LOG_UART via STUB_COMPILE_DEFS

  • to change the default buffer size: pass STUB_LIB_LOG_BUF_SIZE=2048 via STUB_COMPILE_DEFS

(eg, set(STUB_COMPILE_DEFS "STUB_LOG_ENABLED;STUB_LIB_LOG_BUF;STUB_LIB_LOG_BUF_SIZE=2048"))

@github-actions
Copy link

github-actions bot commented Apr 15, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "logger: add logging to a RAM buffer":
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]
  • the commit message "logger: fix format, no discard the last \n in that case":
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]

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 antmak, 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 305302a

@antmak antmak force-pushed the feat/log_buf branch 2 times, most recently from 814f41e to 456586a Compare April 27, 2025 03:47
@antmak antmak marked this pull request as ready for review April 27, 2025 03:57
@antmak antmak requested a review from erhankur April 27, 2025 03:57
@antmak antmak requested a review from erhankur April 28, 2025 10:38
@antmak antmak requested a review from gerekon April 29, 2025 12:48
Copy link
Collaborator

@gerekon gerekon left a comment

Choose a reason for hiding this comment

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

LGTM

@antmak antmak requested a review from gerekon April 30, 2025 06:31
@erhankur
Copy link
Collaborator

@antmak Thanks. LGTM

@erhankur erhankur merged commit 946d181 into espressif:master Apr 30, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants