Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/espressif/esp-idf-panic-decoder
https://github.com/espressif/esp-idf-panic-decoder
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/espressif/esp-idf-panic-decoder
- Owner: espressif
- License: apache-2.0
- Created: 2023-07-18T10:15:25.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-23T03:38:20.000Z (4 months ago)
- Last Synced: 2024-05-23T03:47:20.382Z (4 months ago)
- Language: Python
- Size: 42 KB
- Stars: 2
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ESP IDF panic decoder
The ```esp-idf-panic-decoder``` is a Python-based, open-source package that is part of the [ESP-IDF](https://github.com/espressif/esp-idf) SDK for Espressif products.
The main part is a script that parses ESP-IDF panic handler output (registers & stack dump), and then acts as a GDB server over stdin/stdout, presenting the information from the panic handler to GDB.
This allows for generating backtraces out of raw stack dumps on architectures
where backtracing on the target side is not possible.
## Contributing
### Code Style & Static Analysis
Please follow these coding standards when writing code for ``esp-idf-panic-decoder``:
#### Pre-commit checks
[pre-commit](https://pre-commit.com/) is a framework for managing pre-commit hooks. These hooks help to identify simple issues before committing code for review.
To use the tool, first install ``pre-commit``. Then enable the ``pre-commit`` and ``commit-msg`` git hooks:
```sh
python -m pip install pre-commit
pre-commit install -t pre-commit -t commit-msg
```
On the first commit ``pre-commit`` will install the hooks, subsequent checks will be significantly faster. If an error is found an appropriate error message will be displayed.
#### Conventional Commits
``esp-idf-panic-decoder`` complies with the [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/#specification). Every commit message is checked with [Conventional Precommit Linter](https://github.com/espressif/conventional-precommit-linter), ensuring it adheres to the standard.
## License
This document and the attached source code are released as Free Software under Apache License Version 2. See the accompanying [LICENSE file](https://github.com/espressif/esp-idf-panic-decoder/blob/master/LICENSE) for a copy.