espressif/esptool
1
0
Fork 0
mirror of https://github.com/espressif/esptool.git synced 2025-10-15 21:07:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(elf2image): Fix incorrect logger call

Browse Source 
Replace the non-existing `log.info` call by the `log.note` and update the docs accordingly.

Signed-off-by: Marek Matej <marek.matej@espressif.com>
This commit is contained in:
Marek Matej
2025-07-08 16:54:09 +02:00
committed by Radim Karniš
parent 785a3db318
commit 637f0e6116
3 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/esptool/scripting.rst
View File

@@ -354,4 +354,4 @@ To ensure compatibility with esptool, the custom logger should re-implement (or
:members: print, note, warning, error, stage, progress_bar, set_verbosity
:member-order: bysource
These methods are essential for maintaining proper integration and behavior with esptool. Additionally, all output printing should be made using ``log.print()`` (or the respective method, such as ``log.info()`` or ``log.warning()``) instead of the standard ``print()`` function to ensure the output is routed through the custom logger. This ensures consistency and allows the custom logger to handle all output appropriately. You can further customize this logger to fit your application's needs, such as integrating with GUI components or advanced logging frameworks.
These methods are essential for maintaining proper integration and behavior with esptool. Additionally, all output printing should be made using ``log.print()`` (or the respective method, such as ``log.note()`` or ``log.warning()``) instead of the standard ``print()`` function to ensure the output is routed through the custom logger. This ensures consistency and allows the custom logger to handle all output appropriately. You can further customize this logger to fit your application's needs, such as integrating with GUI components or advanced logging frameworks.

2
docs/en/migration-guide.rst
View File

@@ -77,7 +77,7 @@ The esptool ``v5`` release introduces a centralized logging mechanism to improve
**Migration Steps:**
1. If your scripts rely on direct ``print()`` statements, update them to use the centralized logger for consistent output. Calls to the logger should be made using ``log.print()`` (or the respective method, such as ``log.info()``, ``log.warning()``, or ``log.error()``).
1. If your scripts rely on direct ``print()`` statements, update them to use the centralized logger for consistent output. Calls to the logger should be made using ``log.print()`` (or the respective method, such as ``log.note()``, ``log.warning()``, or ``log.error()``).
2. Refer to the provided documentation to implement custom loggers as needed.
3. Update GUIs or tools to leverage the progress tracking API for better user feedback during lengthy operations.

2
esptool/bin_image.py
View File

@@ -443,7 +443,7 @@ class BaseFirmwareImage(object):
elem_pad_addr != elem.addr + len(elem.data)
and elem_pad_addr == next_elem.addr
):
log.info(
log.note(
"Inserting {} bytes padding between {} and {}".format(
next_elem.addr - (elem.addr + len(elem.data)),
elem.name,