mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
esp-idf/docs/sphinx-known-warnings.txt

58 wiersze
3.4 KiB
Plaintext
Czysty Zwykły widok Historia

ci: Add new check_doc_warnings.sh script, pre-process log lines * Fixes issue in !1250 when IDF_PATH changes on build runner * Allows checking document warnings before CI run * Will be robust to line number changes in document files
2017-09-14 00:34:25 +00:00
# File contains known/allowed Sphinx warnings.
#
# Build will fail if sphinx-warning-log.txt contains any lines
# which are not in this file. Lines are pre-sanitized by
docs: Add features to build_docs.py: check warnings, check links, check GH links The old check_doc_warnings.sh was deleted
2020-01-03 11:00:23 +00:00
# `build_docs.py build` to remove formatting, paths and line numbers.
ci: Add new check_doc_warnings.sh script, pre-process log lines * Fixes issue in !1250 when IDF_PATH changes on build runner * Allows checking document warnings before CI run * Will be robust to line number changes in document files
2017-09-14 00:34:25 +00:00
#
# Warnings in this file must be in the same overall order as the log file.
#
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
esp_ble_mesh_defs.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/bluetooth/esp-ble-mesh:line.
Declaration is '.. cpp:member:: uint16_t model_id'.
esp_bt_defs.inc:line: WARNING: Duplicate C declaration, also defined at api-reference/bluetooth/esp_blufi:line.
Declaration is '.. c:macro:: ESP_BD_ADDR_LEN'.
esp_bt_defs.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/bluetooth/esp_blufi:line.
Declaration is '.. cpp:type:: uint8_t esp_bd_addr_t [ESP_BD_ADDR_LEN]'.
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
esp_spp_api.inc:line: WARNING: Error in type declaration.
If typedef-like declaration:
Type must be either just a name or a typedef-like declaration.
If just a name:
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
Error in declarator or parameters-and-qualifiers
Invalid C++ declaration: Expected identifier in nested name, got keyword: void [error at 4]
void() esp_spp_cb_t (esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
----^
If typedef-like declaration:
Error in declarator
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
If declarator-id with parameters-and-qualifiers:
Invalid C++ declaration: Expected identifier in nested name. [error at 4]
void() esp_spp_cb_t (esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
----^
If parenthesis in noptr-declarator:
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
Error in declarator or parameters-and-qualifiers
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
If pointer to member declarator:
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
Invalid C++ declaration: Expected identifier in nested name. [error at 5]
void() esp_spp_cb_t (esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
-----^
If declarator-id:
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
Invalid C++ declaration: Expected identifier in nested name. [error at 5]
void() esp_spp_cb_t (esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
-----^
If type alias or template alias:
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
Invalid C++ declaration: Expected identifier in nested name, got keyword: void [error at 4]
void() esp_spp_cb_t (esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
docs: Preparation for upgrade of Sphinx and Breathe packages to versions 1.8.4 and 4.11.1. Updated check of Sphinx warnings to account for the filename instead of the whole path, that for the same errors may be different between English and Chinese docs.
2019-02-16 19:46:49 +00:00
----^
mcpwm: add HAL layer support Also improved the unit tests a bit.
2019-11-17 12:53:29 +00:00
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-04-01 03:54:56 +00:00
spi_master.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/peripherals/spi_master:line.
Declaration is '.. cpp:type:: struct spi_transaction_t spi_transaction_t'.
spi_slave.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/peripherals/spi_slave:line.
Declaration is '.. cpp:type:: struct spi_slave_transaction_t spi_slave_transaction_t'.
esp_flash.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/storage/spi_flash:line.
Declaration is '.. cpp:type:: struct esp_flash_t esp_flash_t'.
wear-levelling.rst:line: WARNING: Duplicate C++ declaration, also defined at api-reference/storage/fatfs:line.
Declaration is '.. cpp:struct:: esp_vfs_fat_mount_config_t'.
wear-levelling.rst:line: WARNING: Duplicate C++ declaration, also defined at api-reference/storage/fatfs:line.
Declaration is '.. cpp:member:: bool format_if_mount_failed'.
wear-levelling.rst:line: WARNING: Duplicate C++ declaration, also defined at api-reference/storage/fatfs:line.
Declaration is '.. cpp:member:: int max_files'.
wear-levelling.rst:line: WARNING: Duplicate C++ declaration, also defined at api-reference/storage/fatfs:line.
Declaration is '.. cpp:member:: size_t allocation_unit_size'.