Skip to content

Commit

Permalink
Sync Docs platformio/platformio-core@9d1593d
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivankravets
ivankravets committed Mar 21, 2024
1 parent 4d2e30d commit 679aede
Show file tree
Hide file tree
Showing 1,861 changed files with 3,902 additions and 3,808 deletions.
4 changes: 2 additions & 2 deletions en/stable/404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

<script src="/en/latest/_static/jquery.js?v=5d32c60e"></script>
<script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="/en/latest/_static/documentation_options.js?v=786f2384"></script>
<script src="/en/latest/_static/documentation_options.js?v=b3e6b349"></script>
<script src="/en/latest/_static/doctools.js?v=888ff710"></script>
<script src="/en/latest/_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="/en/latest/_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -250,7 +250,7 @@ <h1>Page not found</h1>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
5 changes: 5 additions & 0 deletions en/stable/_sources/core/userguide/cmd_test.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,11 @@ List project tests without processing.
The :option:`pio test --json-output-path` or :option:`pio test --junit-output-path`
options can be used for dumping available test suites.

.. option::
--json-output

Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format.

.. option::
--json-output-path

Expand Down
6 changes: 3 additions & 3 deletions en/stable/_sources/core/userguide/device/cmd_monitor.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ using :ref:`projectconf_monitor_echo` option.
.. option::
--encoding

Set the encoding for the serial port (e.g. ``hexlify``, ``Latin1``, ``UTF-8``),
default ``UTF-8``.
Set the encoding for the serial port (e.g. ``hexlify``, ``Latin-1``, ``UTF-8``),
default ``UTF-8``. See the full list of `supported encodings <https://docs.python.org/3/library/codecs.html#standard-encodings>`_.

Can be customized in :ref:`projectconf`
using :ref:`projectconf_monitor_encoding` option.
Expand Down Expand Up @@ -272,7 +272,7 @@ See the base API below:
**Examples**

- https://github.com/platformio/platformio-core/tree/develop/platformio/device/filters
- https://github.com/platformio/platformio-core/tree/develop/platformio/device/monitor/filters
- https://github.com/platformio/platform-espressif32/tree/develop/monitor
- https://github.com/platformio/platform-espressif8266/tree/develop/monitor

Expand Down
1 change: 0 additions & 1 deletion en/stable/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ test-driven methodologies, and modern toolchains for unrivaled success.

**Social:** `LinkedIn <https://www.linkedin.com/company/platformio/>`_ |
`Twitter <https://twitter.com/PlatformIO_Org>`_ |
`Facebook <https://www.facebook.com/platformio>`_ |
`Community Forums <https://community.platformio.org>`_

Contents
Expand Down
6 changes: 3 additions & 3 deletions en/stable/_sources/integration/ci/github-actions.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ This variant is default choice for native PlatformIO projects:
key: ${{ runner.os }}-pio
- uses: actions/setup-python@v4
with:
python-version: '3.9'
python-version: '3.11'
- name: Install PlatformIO Core
run: pip install --upgrade platformio
Expand Down Expand Up @@ -103,7 +103,7 @@ and boards from command line interface:
key: ${{ runner.os }}-pio
- uses: actions/setup-python@v4
with:
python-version: '3.9'
python-version: '3.11'
- name: Install PlatformIO Core
run: pip install --upgrade platformio
Expand Down Expand Up @@ -157,7 +157,7 @@ Integration for USB_Host_Shield_2.0 project. The ``workflow.yml`` configuration
key: ${{ runner.os }}-pio
- uses: actions/setup-python@v4
with:
python-version: '3.9'
python-version: '3.11'
- name: Install PlatformIO Core
run: pip install --upgrade platformio
Expand Down
6 changes: 3 additions & 3 deletions en/stable/_sources/integration/ci/gitlab.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This variant is default choice for native PlatformIO projects:

.. code-block:: yaml
image: python:3.9
image: python:3.11
cache:
paths:
Expand All @@ -73,7 +73,7 @@ and boards from command line interface:

.. code-block:: yaml
image: python:3.9
image: python:3.11
cache:
paths:
Expand All @@ -100,7 +100,7 @@ Examples

.. code-block:: yaml
image: python:3.9
image: python:3.11
cache:
paths:
Expand Down
6 changes: 3 additions & 3 deletions en/stable/_sources/integration/ci/shippable.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This variant is default choice for native PlatformIO projects:
language: python
python:
- "3.9"
- "3.11"
install:
- pip install -U platformio
Expand All @@ -73,7 +73,7 @@ and boards from command line interface:
language: python
python:
- "3.9"
- "3.11"
env:
- PLATFORMIO_CI_SRC=path/to/source/file.c
Expand All @@ -97,7 +97,7 @@ Examples
language: python
python:
- "3.9"
- "3.11"
env:
- PLATFORMIO_CI_SRC=examples/Bluetooth/PS3SPP/PS3SPP.ino
Expand Down
12 changes: 6 additions & 6 deletions en/stable/_sources/integration/ci/travis.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This variant is default choice for native PlatformIO projects:
language: python
python:
- "3.9"
- "3.11"
# Cache PlatformIO packages using Travis CI container-based infrastructure
sudo: false
Expand Down Expand Up @@ -96,7 +96,7 @@ and boards from command line interface:
language: python
python:
- "3.9"
- "3.11"
# Cache PlatformIO packages using Travis CI container-based infrastructure
sudo: false
Expand Down Expand Up @@ -198,7 +198,7 @@ Examples
dist: focal
language: python
python:
- "3.9"
- "3.11"
# Cache PlatformIO packages using Travis CI container-based infrastructure
cache:
Expand Down Expand Up @@ -238,7 +238,7 @@ Examples
dist: focal
language: python
python:
- "3.9"
- "3.11"
# Cache PlatformIO packages using Travis CI container-based infrastructure
cache:
Expand Down Expand Up @@ -275,7 +275,7 @@ Examples
dist: focal
language: python
python:
- "3.9"
- "3.11"
# Cache PlatformIO packages using Travis CI container-based infrastructure
cache:
Expand Down Expand Up @@ -315,7 +315,7 @@ Examples
dist: focal
language: python
python:
- "3.9"
- "3.11"
# Cache PlatformIO packages using Travis CI container-based infrastructure
cache:
Expand Down
2 changes: 1 addition & 1 deletion en/stable/_sources/integration/ide/vscode.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Setting Up the Project

.. image:: ../../_static/images/ide/vscode/platformio-ide-vscode-new-project.png

3. Open ``main.cpp`` file form ``src`` folder and replace its contents with
3. Open ``main.cpp`` file from ``src`` folder and replace its contents with
the next:

.. warning::
Expand Down
5 changes: 5 additions & 0 deletions en/stable/_sources/librarymanager/ldf.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,11 @@ project (:ref:`projectconf_pio_src_dir`) and can work in the next modes:
The mode can be changed using :ref:`projectconf_lib_ldf_mode` option in
:ref:`projectconf`. Default value is set to ``chain``.


.. note::
Once a library is picked by the LDF for the build process, all source files
according to its manifest file will be built.

.. note::
Usually, when the LDF appears to fail to identify a dependency of a library,
it is because the dependency is only referenced from a library source file,
Expand Down
2 changes: 1 addition & 1 deletion en/stable/_sources/manifests/library-json/fields/build/extrascript.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Launch extra script before a build process.

.. warning::
The :ref:`scripting_actions` can only be applied to the global
construction environemnt (see :ref:`scripting_envs`).
construction environment (see :ref:`scripting_envs`).

**Example** (HAL-based library)

Expand Down
38 changes: 33 additions & 5 deletions en/stable/_sources/plus/debug-tools/esp-prog.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,25 +68,53 @@ Wiring Connections
:header-rows: 1

* - ESP-Prog JTAG 10-Pin Connector
- Board JTAG Pin
- JTAG Signal
- ESP32 Pin
- ESP32-S2 and ESP32-S3 Pin
- ESP32-C2, ESP32-C3, ESP32-C6, and ESP32-P4 Pin
- ESP32-H2 Pin
- Description
* - 1
- VDD
- VDD
- VDD
- VDD
- VDD
- Positive Supply Voltage — Power supply for JTAG interface drivers
* - 3
- GND
- GND
- GND
- GND
- GND
- Digital ground
* - 2
- ESP_TMS
- TMS
- GPIO14
- GPIO42
- GPIO4
- GPIO2
- Test Mode State
* - 4
- ESP_TCK
- TCK
- GPIO13
- GPIO39
- GPIO6
- GPIO4
- JTAG Return Test Clock
* - 6
- ESP_TDO
- TDO
- GPIO15
- GPIO40
- GPIO7
- GPIO3
- Test Data Out
* - 8
- ESP_TDI
- TDI
- GPIO12
- GPIO41
- GPIO5
- GPIO5
- Test Data In

Tutorials
Expand Down
2 changes: 1 addition & 1 deletion en/stable/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '6.1.13',
VERSION: '6.1.14',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions en/stable/advanced/static-code-analysis/cli.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=786f2384"></script>
<script src="../../_static/documentation_options.js?v=b3e6b349"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -282,7 +282,7 @@ <h1>CLI Guide<a class="headerlink" href="#cli-guide" title="Link to this heading
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
4 changes: 2 additions & 2 deletions en/stable/advanced/static-code-analysis/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=786f2384"></script>
<script src="../../_static/documentation_options.js?v=b3e6b349"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -294,7 +294,7 @@ <h1>Configuration<a class="headerlink" href="#configuration" title="Link to this
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
4 changes: 2 additions & 2 deletions en/stable/advanced/static-code-analysis/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=786f2384"></script>
<script src="../../_static/documentation_options.js?v=b3e6b349"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -319,7 +319,7 @@
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
4 changes: 2 additions & 2 deletions en/stable/advanced/static-code-analysis/severity.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=786f2384"></script>
<script src="../../_static/documentation_options.js?v=b3e6b349"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -288,7 +288,7 @@
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
4 changes: 2 additions & 2 deletions en/stable/advanced/static-code-analysis/tools/clang-tidy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=786f2384"></script>
<script src="../../../_static/documentation_options.js?v=b3e6b349"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -427,7 +427,7 @@ <h2><a class="toc-backref" href="#id4" role="doc-backlink">Extra flags</a><a cla
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
4 changes: 2 additions & 2 deletions en/stable/advanced/static-code-analysis/tools/cppcheck.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

<script src="../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../_static/documentation_options.js?v=786f2384"></script>
<script src="../../../_static/documentation_options.js?v=b3e6b349"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand Down Expand Up @@ -519,7 +519,7 @@ <h3><a class="toc-backref" href="#id8" role="doc-backlink">CERT</a><a class="hea
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Documentation</span>
v6.1.13 (stable)
v6.1.14 (stable)
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
Expand Down
Loading

0 comments on commit 679aede

Please sign in to comment.