alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

tools: fix hints templates

Browse Source
This commit is contained in:
simon.chupin 2022-08-25 18:00:23 +02:00 committed by Simon Chupin
parent 39c47cb6d8
commit f2424e9b93
2 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
tools/idf_py_actions/hints.yml
View File

@ -45,14 +45,14 @@
hint: "Function '{}' has been removed. Please use the function {}." hint: "Function '{}' has been removed. Please use the function {}."
variables: variables:
- -
re_variables: [bootloader_common_get_reset_reason] re_variables: ['bootloader_common_get_reset_reason']
hint_variables: [bootloader_common_get_reset_reason(), "'esp_rom_get_reset_reason()' in the ROM component"] hint_variables: ['bootloader_common_get_reset_reason()', "'esp_rom_get_reset_reason()' in the ROM component"]
- -
re_variables: [esp_efuse_get_chip_ver] re_variables: ['esp_efuse_get_chip_ver']
hint_variables: [esp_efuse_get_chip_ver(), efuse_hal_get_major_chip_version(), efuse_hal_get_minor_chip_version() or efuse_hal_chip_revision() instead] hint_variables: ['esp_efuse_get_chip_ver()', 'efuse_hal_get_major_chip_version()', 'efuse_hal_get_minor_chip_version() or efuse_hal_chip_revision() instead']
- -
re_variables: [(esp_spiram_get_chip_size|esp_spiram_get_size)] re_variables: ['(esp_spiram_get_chip_size|esp_spiram_get_size)']
hint_variables: [esp_spiram_get_chip_size and esp_spiram_get_size, esp_psram_get_size()] hint_variables: ['esp_spiram_get_chip_size and esp_spiram_get_size', 'esp_psram_get_size()']
- -
re: "error: implicit declaration of function 'esp_secure_boot_verify_sbv2_signature_block|esp_secure_boot_verify_rsa_signature_block'" re: "error: implicit declaration of function 'esp_secure_boot_verify_sbv2_signature_block|esp_secure_boot_verify_rsa_signature_block'"
@ -63,14 +63,14 @@
hint: '{0}.h header file is not included by esp_system.h anymore. It shall then be manually included with #include "{0}.h"' hint: '{0}.h header file is not included by esp_system.h anymore. It shall then be manually included with #include "{0}.h"'
variables: variables:
- -
re_variables: [(esp_random|esp_fill_random)] re_variables: ['(esp_random|esp_fill_random)']
hint_variables: [esp_random] hint_variables: ['esp_random']
- -
re_variables: [(esp_base_mac_addr_(s|g)et|esp_efuse_mac_get_(custom|default)|esp_read_mac|esp_derive_local_mac)] re_variables: ['(esp_base_mac_addr_(s|g)et|esp_efuse_mac_get_(custom|default)|esp_read_mac|esp_derive_local_mac)']
hint_variables: [esp_mac] hint_variables: ['esp_mac']
- -
re_variables: [esp_chip_info] re_variables: ['esp_chip_info']
hint_variables: [esp_chip_info] hint_variables: ['esp_chip_info']
- -
re: "fatal error: (spiram.h|esp_spiram.h): No such file or directory" re: "fatal error: (spiram.h|esp_spiram.h): No such file or directory"
@ -82,31 +82,31 @@
hint: "Use {} defined in esp_cpu.h instead of {}." hint: "Use {} defined in esp_cpu.h instead of {}."
variables: variables:
- -
re_variables: [esp_cpu_ccount_t] re_variables: ['esp_cpu_ccount_t']
hint_variables: [esp_cpu_cycle_count_t, esp_cpu_ccount_t] hint_variables: ['esp_cpu_cycle_count_t', 'esp_cpu_ccount_t']
- -
re_variables: [esp_cpu_get_ccount] re_variables: ['esp_cpu_get_ccount']
hint_variables: [esp_cpu_get_cycle_count(), esp_cpu_get_ccount] hint_variables: ['esp_cpu_get_cycle_count()', 'esp_cpu_get_ccount']
- -
re_variables: [esp_cpu_set_ccount] re_variables: ['esp_cpu_set_ccount']
hint_variables: [esp_cpu_set_cycle_count(), esp_cpu_set_ccount] hint_variables: ['esp_cpu_set_cycle_count()', 'esp_cpu_set_ccount']
- -
re: "fatal error: {}: No such file or directory" re: "fatal error: {}: No such file or directory"
hint: "{} was removed. Include {} instead." hint: "{} was removed. Include {} instead."
variables: variables:
- -
re_variables: [esp_intr.h] re_variables: ['esp_intr.h']
hint_variables: [esp_intr.h, esp_intr_alloc.h] hint_variables: ['esp_intr.h', 'esp_intr_alloc.h']
- -
re_variables: [soc/cpu.h] re_variables: ['soc/cpu.h']
hint_variables: [soc/cpu.h, and use the API function provided by esp_cpu.h] hint_variables: ['soc/cpu.h', 'and use the API function provided by esp_cpu.h']
- -
re_variables: [compare_set.h] re_variables: ['compare_set.h']
hint_variables: [compare_set.h, and use the API function provided by esp_cpu.h] hint_variables: ['compare_set.h', 'and use the API function provided by esp_cpu.h']
- -
re_variables: [esp_panic.h] re_variables: ['esp_panic.h']
hint_variables: [esp_panic.h, use functionalities provided in esp_debug_helpers.h] hint_variables: ['esp_panic.h', 'use functionalities provided in esp_debug_helpers.h']
- -
re: "error: implicit declaration of function 'esp_int_wdt_\\w+'" re: "error: implicit declaration of function 'esp_int_wdt_\\w+'"
@ -156,20 +156,20 @@
hint: 'The {0} (functions/types/macros prefixed with "{1}") has been made into a private API. If users still require usage of the {0} (though this is not recommended), it can be included via #include "esp_private/{2}.h".' hint: 'The {0} (functions/types/macros prefixed with "{1}") has been made into a private API. If users still require usage of the {0} (though this is not recommended), it can be included via #include "esp_private/{2}.h".'
variables: variables:
- -
re_variables: [esp32\\w*\\/clk] re_variables: ['esp32\\w*\\/clk']
hint_variables: [ESP Clock API, esp_clk, esp_clk] hint_variables: ['ESP Clock API', 'esp_clk', 'esp_clk']
- -
re_variables: [esp32\\w*\\/cache_err_int] re_variables: ['esp32\\w*\\/cache_err_int']
hint_variables: [Cache Error Interrupt API, esp_cache_err, cache_err_int] hint_variables: ['Cache Error Interrupt API', 'esp_cache_err', 'cache_err_int']
- -
re_variables: [brownout] re_variables: ['brownout']
hint_variables: [Brownout API, esp_brownout, brownout] hint_variables: ['Brownout API', 'esp_brownout', 'brownout']
- -
re_variables: [trax] re_variables: ['trax']
hint_variables: [Trax API, trax_, trax] hint_variables: ['Trax API', 'trax_', 'trax']
- -
re_variables: [eh_frame_parser] re_variables: ['eh_frame_parser']
hint_variables: [Backtrace Parser API, eh_frame_parser, eh_frame_parser] hint_variables: ['Backtrace Parser API', 'eh_frame_parser', 'eh_frame_parser']
- -
re: "fatal error: esp_adc_cal.h: No such file or directory" re: "fatal error: esp_adc_cal.h: No such file or directory"

4
tools/idf_py_actions/tools.py
View File

@ -109,8 +109,8 @@ def print_hints(*filenames: str) -> None:
try: try:
if variables_list: if variables_list:
for variables in variables_list: for variables in variables_list:
hint_vars = variables['re_variables'] hint_vars = variables['hint_variables']
re_vars = variables['hint_variables'] re_vars = variables['re_variables']
regex = hint['re'].format(*re_vars) regex = hint['re'].format(*re_vars)
if re.compile(regex).search(output): if re.compile(regex).search(output):
try: try: