esp_hw_support: add hints for breaking changes.

hints are added:
- to indicate that esp_cpu_ccount_t must be replaced by esp_cpu_cycle_count_t
- to indicate that esp_cpu_get/set_ccount must be replaced by esp_cpu_get/set_cycle_count
- to indicate that soc/cpu.h and compare_set.h were removed and user must include esp_cpu.h instead
- to indicate that esp_intr.h was removed and user must include esp_intr_alloc.h instead
- to indicate that esp_panic.h was made private and user must use the functionalities from esp_debug_helper.h instead
- to indicate that spilock.h, clk_ctrl_os.h and rtc_wdt.h must be included without the soc/
- to indicate that soc_log.h was renamed esp_hw_log.h and made private
This commit is contained in:
Guillaume Souchere
2022-08-04 08:32:16 +02:00
parent 6c8375e2d2
commit dfcd7c3b88

View File

@@ -7,6 +7,40 @@
# Rules to write regex for hints on how to resolve errors
# - Do not use more than one whitespace in a row. The script automatically merges several whitespaces into one when capturing output
# - Do not use \n in your regex. They are all automatically deletes by the script when capturing output
-
re: "error: implicit declaration of function 'esp_cpu_ccount_t'"
hint: "Use esp_cpu_cycle_count_t defined in esp_cpu.h instead of esp_cpu_ccount_t."
-
re: "error: implicit declaration of function 'esp_cpu_(g|s)et_ccount'"
hint: "Use esp_cpu_{}et_cycle_count() defined in esp_cpu.h instead."
match_to_output: True
-
re: "fatal error: (soc/cpu.h|compare_set.h): No such file or directory"
hint: "{} was removed. Include and use the API function provided by esp_cpu.h instead."
match_to_output: True
-
re: "fatal error: (esp_intr.h): No such file or directory"
hint: "{} was removed. Include esp_intr_alloc.h instead."
match_to_output: True
-
re: "fatal error: (esp_panic.h): No such file or directory"
hint: "{} was made private. Use functionalities provided in esp_debug_helpers.h instead."
match_to_output: True
-
re: "fatal error: soc/(spinlock.h|clk_ctrl_os.h|rtc_wdt.h): No such file or directory"
hint: "{} must be included without the 'soc' part."
match_to_output: True
-
re: "fatal error: (soc_log.h): No such file or directory"
hint: "{} was renamed and made private. Consider using the logging APIs provided under esp_log.h instead."
match_to_output: True
-
re: "error: implicit declaration of function '(\\w+)'"
hint: "Maybe you forgot to import {} library(s) in header file or add the necessary REQURIES component. Try to add missing libraries to your project header file or check idf_component_register(REQUIRES ...) section in your component CmakeList.txt file. For more information run 'idf.py docs -sp api-guides/build-system.html'."