From eb85cfb9f674b24c58141379227c197d3503d3c2 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Fri, 31 Jan 2020 17:16:03 +1100 Subject: [PATCH] docs: Temporarily mark RF calibration chapter as ESP32 only Can be re-enabled once ESP32-S2 calibration support is added --- components/esp_wifi/Kconfig | 3 ++- docs/conf_common.py | 1 + docs/en/api-guides/index.rst | 2 +- docs/zh_CN/api-guides/index.rst | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/components/esp_wifi/Kconfig b/components/esp_wifi/Kconfig index 26ec0223d1..b238da7f5b 100644 --- a/components/esp_wifi/Kconfig +++ b/components/esp_wifi/Kconfig @@ -308,7 +308,8 @@ endmenu # Wi-Fi menu "PHY" config ESP32_PHY_CALIBRATION_AND_DATA_STORAGE - # ToDo: remove once NVS and PHY partial calibration are supported + # ToDo: remove target dependency once NVS and PHY partial calibration are supported + # also re-enable the entry in docs/../api-guides/index.rst depends on IDF_TARGET_ESP32 bool "Store phy calibration data in NVS" default y diff --git a/docs/conf_common.py b/docs/conf_common.py index 1820e0c352..2e3c60cf14 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -132,6 +132,7 @@ def update_exclude_patterns(tags): for e in ['api-guides/blufi.rst', 'api-guides/build-system-legacy.rst', 'api-guides/esp-ble-mesh/**', + 'api-guides/RF_calibration.rst', # temporary until support re-added in esp_wifi 'api-guides/ulp-legacy.rst', 'api-guides/unit-tests-legacy.rst', 'api-guides/ulp_instruction_set.rst', diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index a6f3a495b5..fa167406fe 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -27,7 +27,7 @@ API Guides Linker Script Generation lwIP TCP/IP Stack Partition Tables - RF Calibration + :esp32: RF Calibration ROM debug console Secure Boot <../security/secure-boot> Thread Local Storage diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 9df13bf124..687521c0e8 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -28,7 +28,7 @@ API 指南 应用层跟踪 控制台终端组件 ROM debug console - RF Calibration + :esp32: RF Calibration WiFi Driver :esp32: ESP-BLE-MESH ESP-MESH (Wi-Fi)