granicus.if.org Git - esp-idf/blob - docs/sphinx-known-warnings.txt

   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 # check_doc_warnings.sh 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 #
  11 # Sphinx known issue https://github.com/sphinx-doc/sphinx/issues/2683
  12 #
  13 # Note: warnings below will be gone after upgrade
  14 #       to the following package==version
  15 #
  16 #       sphinx==1.8.4
  17 #       breathe==4.11.1
  18 #
  19 esp_a2dp_api.inc:line: WARNING: Invalid definition: Expected identifier in nested name. [error at 21]
  20   union esp_a2d_mcc_t::@1  esp_a2d_mcc_t::cie
  21   ---------------------^
  22 esp_bt_defs.inc:line: WARNING: Invalid definition: Expected identifier in nested name. [error at 21]
  23   union esp_bt_uuid_t::@0  esp_bt_uuid_t::uuid
  24   ---------------------^
  25
  26 #
  27 # Breathe known issue: https://github.com/michaeljones/breathe/issues/405
  28 # Sphinx known issue: https://github.com/sphinx-doc/sphinx/pull/5901
  29 #
  30 # Note: warnings below have been identified after upgrade
  31 #       to the following package==version
  32 #
  33 #       sphinx==1.8.4
  34 #       breathe==4.11.1
  35 #
  36 ulp-cmake.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_load_binary(uint32_t load_addr, const uint8_t * program_binary, size_t program_size)
  37 ulp-cmake.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_run(uint32_t entry_point)
  38 ulp-cmake.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_set_wakeup_period(size_t period_index, uint32_t period_us)
  39 README.rst:line: WARNING: Duplicate declaration, esp_err_t ulp_run(uint32_t entry_point)
  40 #
  41 # Issue present only when building on msys2 / mingw32 START >>>
  42 #
  43 esp_spp_api.inc:line: WARNING: Error in type declaration.
  44 If typedef-like declaration:
  45   Type must be either just a name or a typedef-like declaration.
  46   If just a name:
  47     Error in declarator or parameters and qualifiers
  48     Invalid definition: Expected identifier in nested name, got keyword: void [error at 4]
  49       void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
  50       ----^
  51   If typedef-like declaration:
  52     Error in declarator
  53     If pointer to member declarator:
  54       Invalid definition: Expected identifier in nested name. [error at 4]
  55         void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
  56         ----^
  57     If declId, parameters, and qualifiers:
  58       Invalid definition: Expected identifier in nested name. [error at 4]
  59         void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
  60         ----^
  61     If parenthesis in noptr-declarator:
  62       Error in declarator or parameters and qualifiers
  63       If pointer to member declarator:
  64         Invalid definition: Expected identifier in nested name. [error at 5]
  65           void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
  66           -----^
  67       If declarator-id:
  68         Invalid definition: Expected identifier in nested name. [error at 5]
  69           void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
  70           -----^
  71 If type alias or template alias:
  72   Invalid definition: Expected identifier in nested name, got keyword: void [error at 4]
  73     void() esp_spp_cb_t(esp_spp_cb_event_t event, esp_spp_cb_param_t *param)
  74     ----^
  75 #
  76 # Issue present only when building on msys2 / mingw32 END <<<
  77 #
  78 spi_master.inc:line: WARNING: Duplicate declaration, struct spi_transaction_t spi_transaction_t
  79 spi_slave.inc:line: WARNING: Duplicate declaration, struct spi_slave_transaction_t spi_slave_transaction_t
  80 wear-levelling.rst:line: WARNING: Duplicate declaration, bool esp_vfs_fat_mount_config_t::format_if_mount_failed
  81 wear-levelling.rst:line: WARNING: Duplicate declaration, int esp_vfs_fat_mount_config_t::max_files
  82 wear-levelling.rst:line: WARNING: Duplicate declaration, size_t esp_vfs_fat_mount_config_t::allocation_unit_size
  83 wear-levelling.rst:line: WARNING: Duplicate declaration, esp_vfs_fat_mount_config_t