Skip to content

Commit a9794f9

Browse files
Update partition_table.rst with Variants Folder detail (#8531)
* Update partition_table.rst Updating Partition Table Partition with information regarding Variants folder * Update docs/source/tutorials/partition_table.rst Co-authored-by: Jan Procházka <[email protected]> --------- Co-authored-by: Jan Procházka <[email protected]>
1 parent 13772ad commit a9794f9

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

Diff for: docs/source/tutorials/partition_table.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,21 @@ Here is an example you can use for a custom partition table:
131131
132132
This partition will use about 12MB of the 16MB flash. The offset will be automatically calculated after the first application partition and the units are in K and M.
133133

134-
A alternative is to create the new partition table as a new file in the `tools/partitions <https://github.com/espressif/arduino-esp32/tree/master/tools/partitions>`_ folder and edit the `boards.txt <https://github.com/espressif/arduino-esp32/tree/master/boards.txt>`_ file to add your custom partition table.
134+
An alternative is to create the new partition table as a new file in the `tools/partitions <https://github.com/espressif/arduino-esp32/tree/master/tools/partitions>`_ folder and edit the `boards.txt <https://github.com/espressif/arduino-esp32/tree/master/boards.txt>`_ file to add your custom partition table.
135+
136+
Another alternative is to create the new partition table as a new file, and place it in the `variants <https://github.com/espressif/arduino-esp32/tree/master/variants>`_ folder under your boards folder, and edit the `boards.txt <https://github.com/espressif/arduino-esp32/tree/master/boards.txt>`_ file to add your custom partition table, noting that in order for the compiler to find your custom partition table file you must use the '.build.custom_partitions=' option in the boards.txt file, rather than the standard '.build.partitions=' option. The '.build.variant=' option has the name of the folder holding your custom partition table in the variants folder.
137+
138+
An example of the PartitionScheme listing using the ESP32S3 Dev Module as a reference, would be to have the following:
139+
140+
**Custom Partition - CSV file in /variants/custom_esp32s3/ folder**
141+
142+
.. code-block::
143+
144+
esp32s3.build.variant=custom_esp32s3
145+
--
146+
esp32s3.menu.PartitionScheme.huge_app=Custom Huge APP (3MB No OTA/1MB SPIFFS)
147+
esp32s3.menu.PartitionScheme.huge_app.build.custom_partitions=custom_huge_app
148+
esp32s3.menu.PartitionScheme.huge_app.upload.maximum_size=3145728
135149
136150
Examples
137151
--------

0 commit comments

Comments
 (0)