Merge branch 'bugfix/esp_err_ignore_dirs' into 'master'

esp32: Do not document error codes defined in examples

See merge request idf/esp-idf!2732
This commit is contained in:
Angus Gratton 2018-07-18 08:29:53 +08:00
commit aa4d77467b
2 changed files with 4 additions and 8 deletions

View file

@ -28,9 +28,6 @@
#if __has_include("esp_ping.h") #if __has_include("esp_ping.h")
#include "esp_ping.h" #include "esp_ping.h"
#endif #endif
#if __has_include("esp_slave.h")
#include "esp_slave.h"
#endif
#if __has_include("esp_spi_flash.h") #if __has_include("esp_spi_flash.h")
#include "esp_spi_flash.h" #include "esp_spi_flash.h"
#endif #endif
@ -95,10 +92,6 @@ static const esp_err_msg_t esp_err_msg_table[] = {
# endif # endif
# ifdef ESP_ERR_INVALID_MAC # ifdef ESP_ERR_INVALID_MAC
ERR_TBL_IT(ESP_ERR_INVALID_MAC), /* 267 0x10b MAC address was invalid */ ERR_TBL_IT(ESP_ERR_INVALID_MAC), /* 267 0x10b MAC address was invalid */
# endif
// examples/peripherals/sdio/host/components/esp_slave/include/esp_slave.h
# ifdef ESP_ERR_NOT_FINISHED
ERR_TBL_IT(ESP_ERR_NOT_FINISHED), /* 513 0x201 */
# endif # endif
// components/nvs_flash/include/nvs.h // components/nvs_flash/include/nvs.h
# ifdef ESP_ERR_NVS_BASE # ifdef ESP_ERR_NVS_BASE

View file

@ -25,6 +25,9 @@ import textwrap
# list files here which should not be parsed # list files here which should not be parsed
ignore_files = [ 'components/mdns/test_afl_fuzz_host/esp32_compat.h' ] ignore_files = [ 'components/mdns/test_afl_fuzz_host/esp32_compat.h' ]
# add directories here which should not be parsed
ignore_dirs = ( 'examples' )
# macros from here have higher priorities in case of collisions # macros from here have higher priorities in case of collisions
priority_headers = [ 'components/esp32/include/esp_err.h' ] priority_headers = [ 'components/esp32/include/esp_err.h' ]
@ -292,7 +295,7 @@ def main():
for filename in fnmatch.filter(filenames, '*.[ch]'): for filename in fnmatch.filter(filenames, '*.[ch]'):
full_path = os.path.join(root, filename) full_path = os.path.join(root, filename)
path_in_idf = os.path.relpath(full_path, idf_path) path_in_idf = os.path.relpath(full_path, idf_path)
if path_in_idf in ignore_files: if path_in_idf in ignore_files or path_in_idf.startswith(ignore_dirs):
continue continue
with open(full_path, "r+") as f: with open(full_path, "r+") as f:
for line in f: for line in f: