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
5514cee480
esp-idf/docs/sphinx-known-warnings.txt

35 lines
2.6 KiB
Plaintext
Raw Normal View History

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-13 20:34:25 -04: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 06:00:23 -05: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-13 20:34:25 -04:00
#
# Warnings in this file must be in the same overall order as the log file.
#
docs: fix all doxygen warnings Doxygen warnings would previously not result in a failed pipeline. Fixed this as well as all current warnings.
2022-05-11 03:52:09 -04:00
ulp-legacy.rst:line: WARNING: Duplicate C++ declaration, also defined at api-guides/ulp:line.
Declaration is '.. cpp:function:: esp_err_t ulp_load_binary (uint32_t load_addr, const uint8_t *program_binary, size_t program_size)'.
ulp-legacy.rst:line: WARNING: Duplicate C++ declaration, also defined at api-guides/ulp:line.
Declaration is '.. cpp:function:: esp_err_t ulp_run (uint32_t entry_point)'.
ulp-legacy.rst:line: WARNING: Duplicate C++ declaration, also defined at api-guides/ulp:line.
Declaration is '.. cpp:function:: esp_err_t ulp_set_wakeup_period (size_t period_index, uint32_t period_us)'.
README.rst:line: WARNING: Duplicate C++ declaration, also defined at api-guides/ulp:line.
Declaration is '.. cpp:function:: esp_err_t ulp_run (uint32_t entry_point)'.
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-03-31 23:54:56 -04: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'.
component_bt: Fix build doc errors of bt 1. bluedroid: use standard function pointer define. 2. blufi: Change ESP_BD_ADDR_LEN into ESP_BLUFI_BD_ADDR_LEN 3. doc/sphinx_known_warnings: Remove fixed parts.
2022-05-10 04:01:15 -04:00
rmt_encoder.inc:line: WARNING: Duplicate C++ declaration, also defined at api-reference/peripherals/rmt:line.
Declaration is '.. cpp:type:: struct rmt_encoder_t rmt_encoder_t'.
docs: update esp-docs 1.0.0 Update esp-docs to 1.0.0 and fix new warnings introduced from update
2022-03-31 23:54:56 -04: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'.
Reference in New Issue Copy Permalink