You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/contributing.rst
+36-11Lines changed: 36 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -109,17 +109,39 @@ Also:
109
109
Testing
110
110
*******
111
111
112
-
Be sure you have tested the example in all the supported targets. If the example works only with specific targets,
113
-
edit/add the ``ci.json`` in the same folder as the sketch to specify the supported targets. By default,
114
-
all targets are assumed to be supported.
112
+
Be sure you have tested the example in all the supported targets. If the example some specific hardware requirements,
113
+
edit/add the ``ci.json`` in the same folder as the sketch to specify the required configurations from ``sdkconfig``.
114
+
This will ensure that the CI system will run the test only on the targets that have the required configurations.
115
+
You can check the available configurations in the ``sdkconfig`` file in the ``tools/esp32-arduino-libs/<target>`` folder.
115
116
116
-
Here is an example of the ``ci.json`` file where the example does not support ESP32-H2 and ESP32-S2:
117
+
Here is an example of the ``ci.json`` file where the example requires Wi-Fi to work properly:
117
118
118
119
.. code-block:: json
119
120
120
121
{
122
+
"requires": [
123
+
"CONFIG_SOC_WIFI_SUPPORTED=y"
124
+
]
125
+
}
126
+
127
+
.. note::
128
+
129
+
The list of configurations will be checked against the ``sdkconfig`` file in the target folder. If the configuration is not present in the ``sdkconfig``,
130
+
the test will be skipped for that target. That means that the test will only run on the targets that have **ALL** the required configurations.
131
+
132
+
Sometimes, the example might not be supported by some target, even if the target has the required configurations
133
+
(like resources limitations or requiring a specific SoC). To avoid compilation errors, you can add the target to the ``ci.json``
134
+
file so the CI system will force to skip the test on that target.
135
+
136
+
Here is an example of the ``ci.json`` file where the example is requires Wi-Fi to work properly but is also not supported by the ESP32-S2 target:
137
+
138
+
.. code-block:: json
139
+
140
+
{
141
+
"requires": [
142
+
"CONFIG_SOC_WIFI_SUPPORTED=y"
143
+
],
121
144
"targets": {
122
-
"esp32h2": false,
123
145
"esp32s2": false
124
146
}
125
147
}
@@ -130,17 +152,17 @@ For example, in the sketch:
130
152
.. code-block:: arduino
131
153
132
154
/*
133
-
THIS FEATURE IS SUPPORTED ONLY BY ESP32-S2 AND ESP32-C3
155
+
THIS FEATURE REQUIRES WI-FI SUPPORT AND IS NOT AVAILABLE FOR ESP32-S2 AS IT DOES NOT HAVE ENOUGH RAM.
134
156
*/
135
157
136
158
And in the ``README.md`` file:
137
159
138
160
.. code-block:: markdown
139
161
140
-
Currently, this example supports the following targets.
162
+
Currently, this example requires Wi-Fi and supports the following targets.
0 commit comments