Просмотр исходного кода

docs: update name length of partition tables

Linda 3 лет назад
Родитель
Сommit
3fa90c8e5d
2 измененных файлов с 4 добавлено и 4 удалено
  1. 3 3
      docs/en/api-guides/partition-tables.rst
  2. 1 1
      docs/zh_CN/api-guides/partition-tables.rst

+ 3 - 3
docs/en/api-guides/partition-tables.rst

@@ -69,7 +69,7 @@ The CSV format is the same format as printed in the summaries shown above. Howev
 Name field
 Name field
 ~~~~~~~~~~
 ~~~~~~~~~~
 
 
-Name field can be any meaningful name. It is not significant to the {IDF_TARGET_NAME}. Names longer than 16 characters will be truncated.
+Name field can be any meaningful name. It is not significant to the {IDF_TARGET_NAME}. The maximum length of names is 16 bytes, including one null terminator. Names longer than the maximum length will be truncated.
 
 
 Type field
 Type field
 ~~~~~~~~~~
 ~~~~~~~~~~
@@ -90,11 +90,11 @@ SubType
 ~~~~~~~
 ~~~~~~~
 {IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp32c2 = "(not updated yet)"}
 {IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp32c2 = "(not updated yet)"}
 
 
-The 8-bit subtype field is specific to a given partition type. ESP-IDF currently only specifies the meaning of the subtype field for ``app`` and ``data`` partition types.
+The 8-bit SubType field is specific to a given partition type. ESP-IDF currently only specifies the meaning of the subtype field for ``app`` and ``data`` partition types.
 
 
 See enum :cpp:type:`esp_partition_subtype_t` for the full list of subtypes defined by ESP-IDF, including the following:
 See enum :cpp:type:`esp_partition_subtype_t` for the full list of subtypes defined by ESP-IDF, including the following:
 
 
-* When type is ``app``, the subtype field can be specified as ``factory`` (0x00), ``ota_0`` (0x10) ... ``ota_15`` (0x1F) or ``test`` (0x20).
+* When type is ``app``, the SubType field can be specified as ``factory`` (0x00), ``ota_0`` (0x10) ... ``ota_15`` (0x1F) or ``test`` (0x20).
 
 
   - ``factory`` (0x00) is the default app partition. The bootloader will execute the factory app unless there it sees a partition of type data/ota, in which case it reads this partition to determine which OTA image to boot.
   - ``factory`` (0x00) is the default app partition. The bootloader will execute the factory app unless there it sees a partition of type data/ota, in which case it reads this partition to determine which OTA image to boot.
 
 

+ 1 - 1
docs/zh_CN/api-guides/partition-tables.rst

@@ -69,7 +69,7 @@ CSV 文件的格式与上面摘要中打印的格式相同,但是在 CSV 文
 Name 字段
 Name 字段
 ~~~~~~~~~
 ~~~~~~~~~
 
 
-Name 字段可以是任何有意义的名称,但不能超过 16 个字(之后的内容将被截断)。该字段对 {IDF_TARGET_NAME} 并不是特别重要。
+Name 字段可以是任何有意义的名称,但不能超过 16 个字节,其中包括一个空字节(之后的内容将被截断)。该字段对 {IDF_TARGET_NAME} 并不是特别重要。
 
 
 Type 字段
 Type 字段
 ~~~~~~~~~
 ~~~~~~~~~