1# File contains known/allowed Sphinx warnings.
2#
3# Build will fail if sphinx-warning-log.txt contains any lines
4# which are not in this file. Lines are pre-sanitized by
5# `build_docs.py build` to remove formatting, paths and line numbers.
6#
7# Warnings in this file must be in the same overall order as the log file.
8#
9#
10# Breathe known issue: https://github.com/michaeljones/breathe/issues/405
11# Sphinx known issue: https://github.com/sphinx-doc/sphinx/pull/5901
12#
13# Note: warnings below have been identified after upgrade
14#       to the following package==version
15#
16#       sphinx==1.8.4
17#       breathe==4.11.1
18#
19ulp.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_load_binary(uint32_t load_addr, const uint8_t * program_binary, size_t program_size)
20ulp.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_run(uint32_t entry_point)
21ulp.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_set_wakeup_period(size_t period_index, uint32_t period_us)
22ulp-legacy.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_load_binary(uint32_t load_addr, const uint8_t * program_binary, size_t program_size)
23ulp-legacy.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_run(uint32_t entry_point)
24ulp-legacy.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_set_wakeup_period(size_t period_index, uint32_t period_us)
25ulp-risc-v.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_set_wakeup_period(size_t period_index, uint32_t period_us)
26README.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_run(uint32_t entry_point)
27
28
29# This seems like a bug, as the field are ::model_id and ::vnd::model_id
30esp_ble_mesh_defs.inc:line: WARNING: Duplicate declaration, uint16_t esp_ble_mesh_model::model_id
31WARNING:esp_bt_defs, use :noindex: for one of them
32WARNING:esp_blufi, use :noindex: for one of them
33esp_bt_defs.inc:line: WARNING: Duplicate declaration, uint8_t esp_bd_addr_t[ESP_BD_ADDR_LEN]
34
35#
36# Issue present only when building on msys2 / mingw32 START >>>
37#
38esp_spp_api.inc:line: WARNING: Error in type declaration.
39If typedef-like declaration:
40  Type must be either just a name or a typedef-like declaration.
41  If just a name:
42    Error in declarator or parameters and qualifiers
43    Invalid definition: Expected identifier in nested name, got keyword: void [error at 4]
44      void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
45      ----^
46  If typedef-like declaration:
47    Error in declarator
48    If pointer to member declarator:
49      Invalid definition: Expected identifier in nested name. [error at 4]
50        void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
51        ----^
52    If declId, parameters, and qualifiers:
53      Invalid definition: Expected identifier in nested name. [error at 4]
54        void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
55        ----^
56    If parenthesis in noptr-declarator:
57      Error in declarator or parameters and qualifiers
58      If pointer to member declarator:
59        Invalid definition: Expected identifier in nested name. [error at 5]
60          void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
61          -----^
62      If declarator-id:
63        Invalid definition: Expected identifier in nested name. [error at 5]
64          void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
65          -----^
66If type alias or template alias:
67  Invalid definition: Expected identifier in nested name, got keyword: void [error at 4]
68    void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
69    ----^
70
71#
72# Issue present only when building on msys2 / mingw32 END <<<
73#
74spi_master.inc:line: WARNING: Duplicate declaration, struct spi_transaction_t spi_transaction_t
75spi_slave.inc:line: WARNING: Duplicate declaration, struct spi_slave_transaction_t spi_slave_transaction_t
76esp_flash.inc:line: WARNING: Duplicate declaration, struct esp_flash_t esp_flash_t
77spi_flash_types.inc:line: WARNING: Duplicate declaration, struct spi_flash_host_driver_t spi_flash_host_driver_t
78wear-levelling.rst:line: WARNING: Duplicate declaration, bool esp_vfs_fat_mount_config_t::format_if_mount_failed
79wear-levelling.rst:line: WARNING: Duplicate declaration, int esp_vfs_fat_mount_config_t::max_files
80wear-levelling.rst:line: WARNING: Duplicate declaration, size_t esp_vfs_fat_mount_config_t::allocation_unit_size
81wear-levelling.rst:line: WARNING: Duplicate declaration, esp_vfs_fat_mount_config_t
82