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
+7-2
Original file line number
Diff line number
Diff line change
@@ -124,6 +124,11 @@ Here is an example of the ``ci.json`` file where the example requires Wi-Fi to w
124
124
]
125
125
}
126
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
+
127
132
Sometimes, the example might not be supported by some target, even if the target has the required configurations
128
133
(like resources limitations or requiring a specific SoC). To avoid compilation errors, you can add the target to the ``ci.json``
129
134
file so the CI system will force to skip the test on that target.
@@ -147,14 +152,14 @@ For example, in the sketch:
147
152
.. code-block:: arduino
148
153
149
154
/*
150
-
THIS FEATURE REQUIRES WI-FI SUPPORT AND IS NOT AVAILABLE FOR ESP32-S2
155
+
THIS FEATURE REQUIRES WI-FI SUPPORT AND IS NOT AVAILABLE FOR ESP32-S2 AS IT DOES NOT HAVE ENOUGH RAM.
151
156
*/
152
157
153
158
And in the ``README.md`` file:
154
159
155
160
.. code-block:: markdown
156
161
157
-
Currently, this example supports the following targets.
162
+
Currently, this example requires Wi-Fi and supports the following targets.
0 commit comments