浏览代码

docs: Note that the idf target formatting filters don't work on "included" documents

Angus Gratton 6 年之前
父节点
当前提交
50324b505d
共有 2 个文件被更改,包括 20 次插入3 次删除
  1. 17 2
      docs/en/api-reference/system/system_time.rst
  2. 3 1
      docs/en/contribute/add-ons-reference.rst

+ 17 - 2
docs/en/api-reference/system/system_time.rst

@@ -19,7 +19,16 @@ The settings for the system time source are as follows:
 - High-resolution timer
 - None
 
-It is recommended to stick to the default setting which provides maximum accuracy. If you want to choose a different timer, configure :ref:`CONFIG_{IDF_TARGET_CFG_PREFIX}_TIME_SYSCALL` in project configuration.
+..
+    (Implementation note: Using only blocks in this file not IDF_CONFIG_CFG_PREFIX, until the zh_CN translation for this document is done.)
+
+.. only:: esp32
+
+    It is recommended to stick to the default setting which provides maximum accuracy. If you want to choose a different timer, configure :ref:`CONFIG_ESP32_TIME_SYSCALL` in project configuration.
+
+.. only:: esp32s2
+
+    It is recommended to stick to the default setting which provides maximum accuracy. If you want to choose a different timer, configure :ref:`CONFIG_ESP32S2_TIME_SYSCALL` in project configuration.
 
 
 RTC Clock Source
@@ -35,7 +44,13 @@ The RTC timer has the following clock sources:
 
 - ``Internal 8.5MHz oscillator, divided by 256 (~33kHz)``. Provides better frequency stability than the ``internal 150kHz RC oscillator`` at the expense of higher (by 5 uA) deep sleep current consumption. It also does not require external components.
 
-The choice depends on your requirements for system time accuracy and power consumption in sleep modes. To modify the RTC clock source, set :ref:`CONFIG_{IDF_TARGET_CFG_PREFIX}_RTC_CLK_SRC` in project configuration.
+.. only:: esp32
+
+    The choice depends on your requirements for system time accuracy and power consumption in sleep modes. To modify the RTC clock source, set :ref:`CONFIG_ESP32_RTC_CLK_SRC` in project configuration.
+
+.. only:: esp32s2
+
+    The choice depends on your requirements for system time accuracy and power consumption in sleep modes. To modify the RTC clock source, set :ref:`CONFIG_ESP32S2_RTC_CLK_SRC` in project configuration.
 
 More details on wiring requirements for the ``External 32kHz crystal`` and ``External 32kHz oscillator at 32K_XP pin`` sources can be found in Section 2.1.4 *Crystal Oscillator* of `Hardware Design Guidelines <https://www.espressif.com/sites/default/files/documentation/esp32_hardware_design_guidelines_en.pdf#page=10>`_.
 

+ 3 - 1
docs/en/contribute/add-ons-reference.rst

@@ -154,7 +154,9 @@ Other Extensions
 
     This will define a replacement of the tag {\IDF_TARGET_TX_PIN} in the current rst-file.
 
-    These replacements cannot be used inside markup that rely on allignment of characters, e.g. tables.
+    These replacements cannot be used inside markup that rely on alignment of characters, e.g. tables.
+
+    These replacement can't be used in a file which is `::include`-ed from another file. *This includes any English document where the ``zh_CN`` translation includes then ``en`` translation*.
 
 Related Documents
 -----------------