Merge branch 'release/v5.2.4'

platformio · Dec 15, 2021 · f04040a · f04040a
2 parents 954974b + 9db45ac
commit f04040a
Show file tree

Hide file tree

Showing 51 changed files with 374 additions and 687 deletions.
diff --git a/_static/css/extra.css b/_static/css/extra.css
@@ -555,7 +555,6 @@ fieldset[disabled] .navbar-inverse .btn-link:focus {
   font-weight: 500;
 }
 
-
 @media screen and (min-width: 992px) {
   ul.nav li.dropdown:hover > ul.dropdown-menu {
     display: block;
@@ -584,70 +583,3 @@ fieldset[disabled] .navbar-inverse .btn-link:focus {
   color: white !important;
   font-weight: bold;
 }
-
-/* Banners */
-
-/* TOP Banner */
-.top-banner {
-    text-shadow: 0 1px 1px rgba(0, 0, 0, .12);
-    width: 100%;
-    padding: 10px 20px;
-    position: relative;
-    min-height: 46px;
-    background-image: -owg-linear-gradient(0deg, #1991EB 2%, #2DA1F8 98%);
-    background-image: -webkit-linear-gradient(0deg, #1991EB 2%, #2DA1F8 98%);
-    background-image: -moz-linear-gradient(0deg, #1991EB 2%, #2DA1F8 98%);
-    background-image: -o-linear-gradient(0deg, #1991EB 2%, #2DA1F8 98%);
-    background-image: linear-gradient(0deg, #1991EB 2%, #2DA1F8 98%);
-    border-color: #397FD0
-}
-
-.top-banner .top-banner-text {
-  color: #fff;
-  text-align: center;
-  line-height: 1.6;
-}
-
-.top-banner .top-banner-get-link {
-  background-color: #fff;
-  border: 1px solid #1991EB;
-  border-radius: 3px;
-  padding: 5px 10px;
-  margin-left: 10px;
-  cursor: pointer;
-  white-space: nowrap;
-  text-decoration: none;
-}
-
-.top-banner .top-banner-get-link:focus,
-.top-banner .top-banner-get-link:hover {
-  background-color: #e6f5fe;
-}
-
-.top-banner .top-banner-close {
-    background-image: url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTAiIGhlaWdodD0iMTEiIHZpZXdCb3g9IjAgMCAxMCAxMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48ZyBzdHJva2U9IiNGRkYiIHN0cm9rZS13aWR0aD0iMiIgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIiBzdHJva2UtbGluZWNhcD0icm91bmQiPjxwYXRoIGQ9Ik0xLjE4MiA5LjMxOGw3LjcxNC03LjcxNE04Ljg5NiA5LjMxOEwxLjE4MiAxLjYwNCIvPjwvZz48L3N2Zz4=);
-    background-size: contain;
-    background-repeat: no-repeat;
-    background-position: center;
-    display: inline-block;
-    width: 12px;
-    height: 12px;
-    margin-top: -1px;
-    right: 20px;
-    position: absolute;
-    top: 50%;
-    cursor: pointer;
-    -webkit-transform: translateY(-50%);
-    -moz-transform: translateY(-50%);
-    -ms-transform: translateY(-50%);
-    -o-transform: translateY(-50%);
-    transform: translateY(-50%);
-    filter: alpha(Opacity=75);
-    opacity: .75;
-}
-
-.top-banner .top-banner-close:focus,
-.top-banner .top-banner-close:hover {
-    filter: alpha(Opacity=100);
-    opacity: 1
-}
diff --git a/_templates/footer.html b/_templates/footer.html
@@ -8,5 +8,6 @@
 {% block extrafooter %}
 {{ super() }}
 {% include "navbar.html" %}
+<ins data-rvad-zoneid="11" data-rvad-id="f837d8c96893e793fdbb230cffb628fc"></ins>
 <script async src="https://ad.platformio.org/delivery/revasyncjs.dll"></script>
 {% endblock %}
diff --git a/articles.rst b/articles.rst
diff --git a/boards/atmelavr/controllino_maxi.rst b/boards/atmelavr/controllino_maxi.rst
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
   * - **RAM**
     - 8KB
   * - **Vendor**
-    - `Controllino <https://controllino.biz/controllino/maxi/?utm_source=platformio.org&utm_medium=docs>`__
+    - `Controllino <https://www.controllino.com/product/controllino-maxi/?utm_source=platformio.org&utm_medium=docs>`__
 
 
 Configuration

diff --git a/boards/atmelavr/controllino_maxi_automation.rst b/boards/atmelavr/controllino_maxi_automation.rst
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
   * - **RAM**
     - 8KB
   * - **Vendor**
-    - `Controllino <https://controllino.biz/controllino/maxi-automation/?utm_source=platformio.org&utm_medium=docs>`__
+    - `Controllino <https://www.controllino.com/product/controllino-maxi-automation/?utm_source=platformio.org&utm_medium=docs>`__
 
 
 Configuration

diff --git a/boards/atmelavr/controllino_mega.rst b/boards/atmelavr/controllino_mega.rst
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
   * - **RAM**
     - 8KB
   * - **Vendor**
-    - `Controllino <https://controllino.biz/controllino/mega/?utm_source=platformio.org&utm_medium=docs>`__
+    - `Controllino <https://www.controllino.com/product/controllino-mega/?utm_source=platformio.org&utm_medium=docs>`__
 
 
 Configuration

diff --git a/boards/atmelavr/controllino_mini.rst b/boards/atmelavr/controllino_mini.rst
@@ -32,7 +32,7 @@ Platform :ref:`platform_atmelavr`: Atmel AVR 8-bit MCUs deliver a unique combina
   * - **RAM**
     - 2KB
   * - **Vendor**
-    - `Controllino <https://controllino.biz/controllino/mini/?utm_source=platformio.org&utm_medium=docs>`__
+    - `Controllino <https://www.controllino.com/product/controllino-mini/?utm_source=platformio.org&utm_medium=docs>`__
 
 
 Configuration

diff --git a/boards/chipsalliance/swervolf_nexys.rst b/boards/chipsalliance/swervolf_nexys.rst
@@ -118,7 +118,4 @@ Frameworks
       - FreeRTOS is a real-time operating system kernel for embedded devices that has been ported to 40 microcontroller platforms
 
     * - :ref:`framework_wd-riscv-sdk`
-      - The WD Firmware package contains firmware applications and Processor Support Package (PSP) for various cores, alongside demos which support all features
-
-    * - :ref:`framework_zephyr`
-      - The Zephyr Project is a scalable real-time operating system (RTOS) supporting multiple hardware architectures, optimized for resource constrained devices, and built with safety and security in mind
+      - The WD Firmware package contains firmware applications and Processor Support Package (PSP) for various cores, alongside demos which support all features
diff --git a/boards/espressif8266/wifi_slot.rst b/boards/espressif8266/wifi_slot.rst
@@ -32,7 +32,7 @@ Platform :ref:`platform_espressif8266`: Espressif Systems is a privately held fa
   * - **RAM**
     - 80KB
   * - **Vendor**
-    - `Amperka <http://wiki.amperka.ru/wifi-slot?utm_source=platformio.org&utm_medium=docs>`__
+    - `Amperka <https://amperka.ru/product/wifi-slot?utm_source=platformio.org&utm_medium=docs>`__
 
 
 Configuration

diff --git a/boards/index.rst b/boards/index.rst
@@ -1277,7 +1277,7 @@ TI TIVA
     :maxdepth: 1
 
     titiva/lplm4f120h5qr
-    titiva/lptm4c1230c3pm
+    titiva/lptm4c123gh6pm
     titiva/lptm4c1294ncpdt
 
 WIZNet W7500

diff --git a/boards/ststm32/disco_h735ig.rst b/boards/ststm32/disco_h735ig.rst
@@ -24,7 +24,7 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
 .. list-table::
 
   * - **Microcontroller**
-    - STM32H735IGK6U
+    - STM32H735IGK6
   * - **Frequency**
     - 550MHz
   * - **Flash**
@@ -58,7 +58,7 @@ board manifest `disco_h735ig.json <https://github.com/platformio/platform-ststm3
   board = disco_h735ig
 
   ; change microcontroller
-  board_build.mcu = stm32h735igk6u
+  board_build.mcu = stm32h735igk6
 
   ; change MCU frequency
   board_build.f_cpu = 550000000L

diff --git a/boards/ststm32/olimexino_stm32f3.rst b/boards/ststm32/olimexino_stm32f3.rst
@@ -24,7 +24,7 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
 .. list-table::
 
   * - **Microcontroller**
-    - STM32F303RCT6TR
+    - STM32F303RCT6
   * - **Frequency**
     - 72MHz
   * - **Flash**
@@ -58,7 +58,7 @@ board manifest `olimexino_stm32f3.json <https://github.com/platformio/platform-s
   board = olimexino_stm32f3
 
   ; change microcontroller
-  board_build.mcu = stm32f303rct6tr
+  board_build.mcu = stm32f303rct6
 
   ; change MCU frequency
   board_build.f_cpu = 72000000L

diff --git a/boards/ststm32/prntr_v2.rst b/boards/ststm32/prntr_v2.rst
@@ -24,7 +24,7 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
 .. list-table::
 
   * - **Microcontroller**
-    - STM32F407RE
+    - STM32F407VET6
   * - **Frequency**
     - 168MHz
   * - **Flash**
@@ -58,7 +58,7 @@ board manifest `prntr_v2.json <https://github.com/platformio/platform-ststm32/bl
   board = prntr_v2
 
   ; change microcontroller
-  board_build.mcu = stm32f407re
+  board_build.mcu = stm32f407vet6
 
   ; change MCU frequency
   board_build.f_cpu = 168000000L

diff --git a/boards/ststm32/st3dp001_eval.rst b/boards/ststm32/st3dp001_eval.rst
@@ -24,7 +24,7 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
 .. list-table::
 
   * - **Microcontroller**
-    - STM32F401VGT6
+    - STM32F401VET6
   * - **Frequency**
     - 84MHz
   * - **Flash**
@@ -58,7 +58,7 @@ board manifest `st3dp001_eval.json <https://github.com/platformio/platform-ststm
   board = st3dp001_eval
 
   ; change microcontroller
-  board_build.mcu = stm32f401vgt6
+  board_build.mcu = stm32f401vet6
 
   ; change MCU frequency
   board_build.f_cpu = 84000000L

diff --git a/boards/ststm32/vccgnd_f407zg_mini.rst b/boards/ststm32/vccgnd_f407zg_mini.rst
@@ -26,9 +26,9 @@ Platform :ref:`platform_ststm32`: The STM32 family of 32-bit Flash MCUs based on
   * - **Microcontroller**
     - STM32F407ZGT6
   * - **Frequency**
-    - 72MHz
+    - 168MHz
   * - **Flash**
-    - 512KB
+    - 1MB
   * - **RAM**
     - 128KB
   * - **Vendor**
@@ -61,7 +61,7 @@ board manifest `vccgnd_f407zg_mini.json <https://github.com/platformio/platform-
   board_build.mcu = stm32f407zgt6
 
   ; change MCU frequency
-  board_build.f_cpu = 72000000L
+  board_build.f_cpu = 168000000L
 
 
 Uploading

diff --git a/boards/titiva/lptm4c1230c3pm.rst → boards/titiva/lptm4c123gh6pm.rst b/boards/titiva/lptm4c1230c3pm.rst → boards/titiva/lptm4c123gh6pm.rst
@@ -9,7 +9,7 @@
     See the License for the specific language governing permissions and
     limitations under the License.
 
-.. _board_titiva_lptm4c1230c3pm:
+.. _board_titiva_lptm4c123gh6pm:
 
 TI LaunchPad (Tiva C) w/ tm4c123 (80MHz)
 ========================================
@@ -24,7 +24,7 @@ Platform :ref:`platform_titiva`: Texas Instruments TM4C12x MCUs offer the indust
 .. list-table::
 
   * - **Microcontroller**
-    - LPTM4C1230C3PM
+    - LPTM4C123GH6PM
   * - **Frequency**
     - 80MHz
   * - **Flash**
@@ -38,27 +38,27 @@ Platform :ref:`platform_titiva`: Texas Instruments TM4C12x MCUs offer the indust
 Configuration
 -------------
 
-Please use ``lptm4c1230c3pm`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
+Please use ``lptm4c123gh6pm`` ID for :ref:`projectconf_env_board` option in :ref:`projectconf`:
 
 .. code-block:: ini
 
-  [env:lptm4c1230c3pm]
+  [env:lptm4c123gh6pm]
   platform = titiva
-  board = lptm4c1230c3pm
+  board = lptm4c123gh6pm
 
 You can override default TI LaunchPad (Tiva C) w/ tm4c123 (80MHz) settings per build environment using
 ``board_***`` option, where ``***`` is a JSON object path from
-board manifest `lptm4c1230c3pm.json <https://github.com/platformio/platform-titiva/blob/master/boards/lptm4c1230c3pm.json>`_. For example,
+board manifest `lptm4c123gh6pm.json <https://github.com/platformio/platform-titiva/blob/master/boards/lptm4c123gh6pm.json>`_. For example,
 ``board_build.mcu``, ``board_build.f_cpu``, etc.
 
 .. code-block:: ini
 
-  [env:lptm4c1230c3pm]
+  [env:lptm4c123gh6pm]
   platform = titiva
-  board = lptm4c1230c3pm
+  board = lptm4c123gh6pm
 
   ; change microcontroller
-  board_build.mcu = lptm4c1230c3pm
+  board_build.mcu = lptm4c123gh6pm
 
   ; change MCU frequency
   board_build.f_cpu = 80000000L

diff --git a/core/index.rst b/core/index.rst
@@ -16,7 +16,7 @@
 PlatformIO Core (CLI)
 =====================
 
-|PIOCORE| (CLI tool) is a heart of whole PlatformIO ecosystem and consists of
+|PIOCORE| (CLI tool) is the heart of the entire PlatformIO ecosystem and consists of
 
 * Multi-platform Build System
 * Development platform and package managers

diff --git a/core/userguide/cmd_check.rst b/core/userguide/cmd_check.rst
@@ -110,6 +110,18 @@ a tool selected for performing check. Possible values described in
 
 Example: ``pio check --fail-on-defect=low --fail-on-defect=medium``
 
+.. option::
+    --skip-packages
+
+Exclude underlying third-party packages from the checking process. By default, PlatformIO
+passes frameworks and toolchains include paths required by internal analysis tools to
+properly analyze project sources. Some of the supported analysis tools use their own
+preprocessor which may fail to parse perfectly valid code and thus provide empty or
+partial check reports. This option is useful when developers have no control over this
+third-party code and want to perform analysis at least on project sources.
+
+Example: ``pio check --skip-packages``
+
 .. option::
     -s, --silent
 

diff --git a/core/userguide/lib/cmd_search.rst b/core/userguide/lib/cmd_search.rst
@@ -65,9 +65,6 @@ The boolean search capability supports the following operators:
       - A phrase that is enclosed within double quote (``"``) characters matches
         only libraries that contain the phrase literally, as it was typed.
 
-For more detail information please go to
-`MySQL Boolean Full-Text Searches <http://dev.mysql.com/doc/refman/5.6/en/fulltext-boolean.html>`_.
-
 Options
 -------
 

diff --git a/core/userguide/system/completion/cmd_install.rst b/core/userguide/system/completion/cmd_install.rst
@@ -21,31 +21,23 @@ Usage
 
 .. code-block:: bash
 
-    pio system completion install [OPTIONS]
+    pio system completion install [OPTIONS] [SHELL]
 
 
 Description
 -----------
 
-Install shell completion files or code.
+Install tab completion support for:
+
+* `fish <https://fishshell.com/>`__
+* `zsh <http://www.zsh.org/>`__
+* `bash <https://www.gnu.org/software/bash>`__
 
 Options
 ~~~~~~~
 
 .. program:: pio system completion install
 
-.. option::
-    --shell
-
-The shell type, default is ``auto`` and will be detected from a current shell session.
-
-Supported shells are:
-
-* `fish <https://fishshell.com/>`__
-* `zsh <http://www.zsh.org/>`__
-* `bash <https://www.gnu.org/software/bash>`__
-* `powershell <https://msdn.microsoft.com/en-us/powershell/mt173057.aspx>`__
-
 .. option::
     --path