Merge branch 'develop' into feature/platformio-30

* develop: (21 commits) Use stable docs Version bump to 2.11.2 (issues #500, #533, #732, #731, #737, #733, #438, #722, #52, #725) Update project configuration template Use stable docs Implement firmware merging with base firmware for Nordic nRF51 development platform // Resolve #500 , Resolve #533 Fix firmware uploading to Atmel SAMD21-XPRO board using ARM mbed framework // Resolve #732 Add firmware merging process for nordicnrf51 // Issue #533, #500 Add OpenOCD as an alternative upload method for atmelsam platform // Issue #732 Sync flags parser with PlatformIO 3.0 branch // Resolve #738 Update ``udev`` rules for the new STM32F407DISCOVERY boards // Resolve #731 Add explanation about "Failed to find MSBuild toolsets directory" Add support for local "--echo" for Serial Port Monitor // Resolve #733 Update history Improve support for Microchip PIC32 development platform and ChipKIT boards // Resolve #438 Fix Project Generator for ESP8266 and ARM mbed based projects Switch to gcc-built LwIP library for espressif platform Push 2.11.2.dev2 Fix linking process for microchippic32 platfrom // Issue #438 Improve Project Generator for PlatformIO IDE (fixes incorrect linter errors)
2016-08-03 00:24:59 +03:00
parent 1cb8d61787 edc04987d3
commit 64b8df6d81
25 changed files with 116 additions and 112 deletions
--- a/HISTORY.rst
+++ b/HISTORY.rst
@ -71,16 +71,30 @@ PlatformIO 3.0
 PlatformIO 2.0
 --------------

-2.11.2 (2016-??-??)
+2.11.2 (2016-08-02)
 ~~~~~~~~~~~~~~~~~~~

+* Improved support for `Microchip PIC32 <http://docs.platformio.org/en/latest/platforms/microchippic32.html>`__ development platform and ChipKIT boards
+  (`issue #438 <https://github.com/platformio/platformio/issues/438>`_)
 * Added support for Pinoccio Scout board
  (`issue #52 <https://github.com/platformio/platformio/issues/52>`_)
 * Added support for `Teensy USB Features <http://docs.platformio.org/en/latest/platforms/teensy.html#usb-features>`__
  (HID, SERIAL_HID, DISK, DISK_SDFLASH, MIDI, etc.)
  (`issue #722 <https://github.com/platformio/platformio/issues/722>`_)
+* Switched to built-in GCC LwIP library for Espressif development platform
+* Added support for local ``--echo`` for Serial Port Monitor
+  (`issue #733 <https://github.com/platformio/platformio/issues/733>`_)
+* Updated ``udev`` rules for the new STM32F407DISCOVERY boards
+  (`issue #731 <https://github.com/platformio/platformio/issues/731>`_)
+* Implemented firmware merging with base firmware for Nordic nRF51 development platform
+  (`issue #500 <https://github.com/platformio/platformio/issues/500>`_,
+  `issue #533 <https://github.com/platformio/platformio/issues/533>`_)
+* Fixed Project Generator for ESP8266 and ARM mbed based projects
+  (resolves incorrect linter errors)
 * Fixed broken LD Script for Element14 chipKIT Pi board
  (`issue #725 <https://github.com/platformio/platformio/issues/725>`_)
+* Fixed firmware uploading to Atmel SAMD21-XPRO board using ARM mbed framework
+  (`issue #732 <https://github.com/platformio/platformio/issues/732>`_)

 2.11.1 (2016-07-12)
 ~~~~~~~~~~~~~~~~~~~
--- a/README.rst
+++ b/README.rst
@ -74,13 +74,13 @@ TI MSP430 & Tiva, Teensy, Arduino, mbed, libOpenCM3, etc.*
 * `Development Platforms <http://platformio.org/platforms>`_
 * `Frameworks <http://platformio.org/frameworks>`_
 * `Embedded Boards Explorer <http://platformio.org/boards>`_
-* `Library Manager <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
-* `User Guide <http://docs.platformio.org/en/latest/userguide/index.html>`_
-* `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
-* `IDE Integration <http://docs.platformio.org/en/latest/ide.html>`_
-* `Articles about us <http://docs.platformio.org/en/latest/articles.html>`_
-* `FAQ <http://docs.platformio.org/en/latest/faq.html>`_
-* `Release Notes <http://docs.platformio.org/en/latest/history.html>`_
+* `Library Manager <http://docs.platformio.org/en/stable/librarymanager/index.html>`_
+* `User Guide <http://docs.platformio.org/en/stable/userguide/index.html>`_
+* `Continuous Integration <http://docs.platformio.org/en/stable/ci/index.html>`_
+* `IDE Integration <http://docs.platformio.org/en/stable/ide.html>`_
+* `Articles about us <http://docs.platformio.org/en/stable/articles.html>`_
+* `FAQ <http://docs.platformio.org/en/stable/faq.html>`_
+* `Release Notes <http://docs.platformio.org/en/stable/history.html>`_

 Use whenever. *Run everywhere.*
 -------------------------------
@ -97,12 +97,12 @@ Embedded Development. *Easier Than Ever.*
 settings for most popular `Embedded Boards <http://platformio.org/boards>`_.

 * Colourful `command-line output <https://raw.githubusercontent.com/platformio/platformio/develop/examples/platformio-examples.png>`_
-* `IDE Integration <http://docs.platformio.org/en/latest/ide.html>`_ with
+* `IDE Integration <http://docs.platformio.org/en/stable/ide.html>`_ with
  *Arduino, Atom, Eclipse, Emacs, Energia, Qt Creator, Sublime Text, Vim, Visual Studio*
-* Cloud compiling and `Continuous Integration <http://docs.platformio.org/en/latest/ci/index.html>`_
+* Cloud compiling and `Continuous Integration <http://docs.platformio.org/en/stable/ci/index.html>`_
  with *AppVeyor, Circle CI, Drone, Shippable, Travis CI*
-* Built-in `Serial Port Monitor <http://docs.platformio.org/en/latest/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ and configurable
-  `build -flags/-options <http://docs.platformio.org/en/latest/projectconf.html#build-flags>`_
+* Built-in `Serial Port Monitor <http://docs.platformio.org/en/stable/userguide/cmd_serialports.html#platformio-serialports-monitor>`_ and configurable
+  `build -flags/-options <http://docs.platformio.org/en/stable/projectconf.html#build-flags>`_
 * Automatic **firmware uploading**
 * Pre-built tool chains, frameworks for the popular `Hardware Platforms <http://platformio.org/platforms>`_

@ -115,10 +115,10 @@ The Missing Library Manager. *It's here!*
 *PlatformIO Library Manager* is the missing library manager for development
 platforms which allows you to organize and have up-to-date external libraries.

-* Friendly `Command-Line Interface <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
+* Friendly `Command-Line Interface <http://docs.platformio.org/en/stable/librarymanager/index.html>`_
 * Modern `Web 2.0 Library Search <http://platformio.org/lib>`_
 * Open Source `Library Registry API <https://github.com/platformio/platformio-api>`_
-* Library Crawler based on `library.json <http://docs.platformio.org/en/latest/librarymanager/config.html>`_
+* Library Crawler based on `library.json <http://docs.platformio.org/en/stable/librarymanager/config.html>`_
  specification
 * Library **dependency management**
 * Automatic library updating
@ -137,7 +137,7 @@ cross-platform substitute for the classic *Make* utility.
 * Reliable detection of *build changes*
 * Improved support for *parallel builds*
 * Ability to share *built files in a cache*
-* Lookup for external libraries which are installed via `Library Manager <http://docs.platformio.org/en/latest/librarymanager/index.html>`_
+* Lookup for external libraries which are installed via `Library Manager <http://docs.platformio.org/en/stable/librarymanager/index.html>`_

 .. image:: https://raw.githubusercontent.com/platformio/platformio-web/develop/app/images/platformio-scons-builder.png
    :target: http://platformio.org
@ -147,9 +147,9 @@ Single source code. *Multiple platforms.*
 -----------------------------------------
 *PlatformIO* allows the developer to compile the same code with different
 development platforms using only *One Command*
-`platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`_.
+`platformio run <http://docs.platformio.org/en/stable/userguide/cmd_run.html>`_.
 This happens due to
-`Project Configuration File (platformio.ini) <http://docs.platformio.org/en/latest/projectconf.html>`_
+`Project Configuration File (platformio.ini) <http://docs.platformio.org/en/stable/projectconf.html>`_
 where you can setup different environments with specific options (platform
 type, firmware uploading settings, pre-built framework, build flags and many
 more).
@ -182,7 +182,7 @@ Frameworks:
 * `SPL <http://platformio.org/frameworks/spl>`_
 * `WiringPi <http://platformio.org/frameworks/wiringpi>`_

-For further details, please refer to `What is PlatformIO? <http://docs.platformio.org/en/latest/faq.html#what-is-platformio>`_
+For further details, please refer to `What is PlatformIO? <http://docs.platformio.org/en/stable/faq.html#what-is-platformio>`_

 Contributing
 ------------
--- a/docs/ide/atom.rst
+++ b/docs/ide/atom.rst
@ -37,7 +37,7 @@ can customize to do anything but also use productively without ever touching a
 config file.

 .. image:: ../_static/ide-atom-platformio.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio.png

 .. contents::

@ -71,9 +71,10 @@ on the "Customize" stage, otherwise ``python`` command will not be available.
 2. Clang for Intelligent Code Autocompletion
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

-PlatformIO IDE uses `clang <http://clang.llvm.org>`_ for the Intelligent Code Autocompletion.
-To check that ``clang`` is available in your system, please open
-Terminal and run ``clang --version``. If ``clang`` is not installed, then install it:
+PlatformIO IDE uses `clang <http://clang.llvm.org>`_ for the Intelligent Code
+Autocompletion. To check that ``clang`` is available in your system, please
+open Terminal and run ``clang --version``. If ``clang`` is not installed,
+then install it and restart Atom:

 - **Mac OS X**: `Install the latest Xcode <https://developer.apple.com/xcode/download/>`_
  along with the latest Command Line Tools
@ -84,6 +85,12 @@ Terminal and run ``clang --version``. If ``clang`` is not installed, then instal

  .. image:: ../_static/clang-installer-add-path.png

+  .. warning::
+      If you see ``Failed to find MSBuild toolsets directory`` error in
+      the installation console, please ignore it and press any key to close
+      this window. PlatformIO IDE uses only Clang completion engine that
+      should work after it without any problems.
+
 - **Linux**: Using package managers: ``apt-get install clang`` or ``yum install clang``.
 - **Other Systems**: Download the latest `Clang for the other systems <http://llvm.org/releases/download.html>`_.

@ -137,30 +144,30 @@ Setting Up the Project
   the corresponding icon in the PlatformIO toolbar as shown in the image below:

 .. image:: ../_static/ide-atom-platformio-quick-start-1.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-1.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-1.png

 2. In the "New Project Menu" choose desired boards (more than one board is
   allowed) and select a project directory. Then press "Initialize" button:

 .. image:: ../_static/ide-atom-platformio-quick-start-2.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-2.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-2.png

 3. If everything is fine, you should see the success message and project tree
   in the left panel:

 .. image:: ../_static/ide-atom-platformio-quick-start-3.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-3.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-3.png

 4. Now, let's create the first project source file: right-click on the folder
   ``src`` and choose ``New File``:

 .. image:: ../_static/ide-atom-platformio-quick-start-4.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-4.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-4.png

 Enter filename ``main.cpp``:

 .. image:: ../_static/ide-atom-platformio-quick-start-5.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-5.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-5.png

 Copy the next source code to the just created file ``main.cpp``:

@ -202,13 +209,13 @@ upload firmware, run other targets) using:
    - :ref:`ide_atom_building_targets` and hotkeys

 .. image:: ../_static/ide-atom-platformio-quick-start-6.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-6.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-6.png

 5. Run ``Build`` and you should see green "success" result in the building
   panel:

 .. image:: ../_static/ide-atom-platformio-quick-start-7.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-7.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-7.png

 To upload firmware to the board run ``Upload``.

@ -217,39 +224,39 @@ To upload firmware to the board run ``Upload``.
   or call targets list from the status bar (bottom, left corner):

 .. image:: ../_static/ide-atom-platformio-quick-start-8.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-8.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-8.png

 And select desired target:

 .. image:: ../_static/ide-atom-platformio-quick-start-9.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-9.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-9.png

 7. To run built-in terminal interface choose ``Menu: PlatformIO > Terminal`` or
   press the corresponding icon in the PlatformIO toolbar:

 .. image:: ../_static/ide-atom-platformio-quick-start-10.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-10.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-10.png

 It provides you fast access to all set of powerful PlatformIO CLI commands:

 .. image:: ../_static/ide-atom-platformio-quick-start-11.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-11.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-11.png

 8. To run built-in "Serial Monitor" choose ``Menu: PlatformIO > Serial Monitor``
   or press the corresponding icon in the PlatformIO toolbar:

 .. image:: ../_static/ide-atom-platformio-quick-start-12.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-12.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-12.png

 It has several settings to adjust your connection:

 .. image:: ../_static/ide-atom-platformio-quick-start-13.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-13.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-13.png

 And allows you to communicate with your board in an easy way:

 .. image:: ../_static/ide-atom-platformio-quick-start-14.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-atom-platformio-quick-start-14.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-atom-platformio-quick-start-14.png


 User Guide
--- a/docs/ide/clion.rst
+++ b/docs/ide/clion.rst
@ -24,7 +24,7 @@ Refer to the `CLion Documentation <https://www.jetbrains.com/clion/documentation
 page for more detailed information.

 .. image:: ../_static/ide-platformio-clion.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-clion.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-clion.png

 .. contents::

--- a/docs/ide/codeblocks.rst
+++ b/docs/ide/codeblocks.rst
@ -14,16 +14,16 @@
 CodeBlocks
 ==========

-Code::Blocks is a free, open-source cross-platform IDE that supports multiple 
-compilers including GCC, Clang and Visual C++. It is developed in C++ using 
-wxWidgets as the GUI toolkit. Using a plugin architecture, its capabilities 
-and features are defined by the provided plugins. Currently, Code::Blocks is 
+Code::Blocks is a free, open-source cross-platform IDE that supports multiple
+compilers including GCC, Clang and Visual C++. It is developed in C++ using
+wxWidgets as the GUI toolkit. Using a plugin architecture, its capabilities
+and features are defined by the provided plugins. Currently, Code::Blocks is
 oriented towards C, C++, and Fortran.

 CodeBlocks IDE can be downloaded from `here <http://www.codeblocks.org/downloads>`_.

 .. image:: ../_static/ide-platformio-codeblocks.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-platformio-codeblocks.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-platformio-codeblocks.png

 .. contents::

--- a/docs/ide/eclipse.rst
+++ b/docs/ide/eclipse.rst
@ -28,7 +28,7 @@ Refer to the `CDT Documentation <https://eclipse.org/cdt/documentation.php>`_
 page for more detailed information.

 .. image:: ../_static/ide-platformio-eclipse.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-eclipse.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-eclipse.png

 .. contents::

--- a/docs/ide/emacs.rst
+++ b/docs/ide/emacs.rst
@ -23,7 +23,7 @@ Refer to the `Emacs Documentation <https://www.gnu.org/software/emacs/#Manuals>`
 page for more detailed information.

 .. image:: ../_static/ide-platformio-emacs.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-emacs.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-emacs.png

 .. contents::

--- a/docs/ide/netbeans.rst
+++ b/docs/ide/netbeans.rst
@ -26,7 +26,7 @@ Just make sure you download the C/C++ version (or if you already use NetBeans,
 install the C/C++ development plugins).

 .. image:: ../_static/ide-platformio-netbeans.png
-    :target: http://docs.platformio.org/en/latest/_images/ide-platformio-netbeans.png
+    :target: http://docs.platformio.org/en/stable/_images/ide-platformio-netbeans.png

 .. contents::

--- a/docs/ide/qtcreator.rst
+++ b/docs/ide/qtcreator.rst
@ -20,7 +20,7 @@ Refer to the `Qt-creator Manual <http://doc.qt.io/qtcreator/>`_
 page for more detailed information.

 .. image:: ../_static/ide-platformio-qtcreator-7.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-7.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-7.png

 .. contents::

@ -83,7 +83,7 @@ Then:
 8. Build project: ``Menu: Build > Build All``.

 .. image:: ../_static/ide-platformio-qtcreator-3.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-3.png

 .. warning::
    The libraries which are added, installed or used in the project
@ -99,7 +99,7 @@ Setup New Project
 First of all, let's create new project from Qt Creator Start Page: ``New Project`` or using ``Menu: File > New File or Project``, then select project with ``Empty Qt Project`` type (``Other Project > Empty Qt Project``), fill ``Name``, ``Create in``.

 .. image:: ../_static/ide-platformio-qtcreator-1.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-1.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-1.png

 On the next steps select any available kit and click Finish button.

@ -108,7 +108,7 @@ On the next steps select any available kit and click Finish button.
 Secondly, we need to delete default build and clean steps and configure project with PlatformIO Build System (click on Projects label on left menu or ``Ctrl+5`` shortcut):

 .. image:: ../_static/ide-platformio-qtcreator-3.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-3.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-3.png

 Thirdly, change project file by adding path to directories with header files. Please edit project file to match the following contents:

@ -125,7 +125,7 @@ Thirdly, change project file by adding path to directories with header files. Pl
    INCLUDEPATH += "$${HOMEDIR}/.platformio/packages/toolchain-atmelavr/avr/include"

 .. image:: ../_static/ide-platformio-qtcreator-4.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-4.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-4.png

 First program in Qt Creator
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -136,7 +136,7 @@ Simple "Blink" project will consist from two files:
 Let's create new text file named ``main.c`` using ``Menu: New File or Project > General > Text File``:

 .. image:: ../_static/ide-platformio-qtcreator-5.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-5.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-5.png

 Copy the source code which is described below to file ``main.c``.

@ -161,22 +161,19 @@ Copy the source code which is described below to file ``main.c``.
 3. Locate the project configuration file named ``platformio.ini`` at the root of the project directory and open it.

 .. image:: ../_static/ide-platformio-qtcreator-6.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-platformio-qtcreator-6.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-platformio-qtcreator-6.png

 Edit the content to match the code described below.

 .. code-block:: none

    #
-    # Project Configuration File
+    # PlatformIO Project Configuration File
    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
+    # Please make sure to read documentation with examples first
+    # http://docs.platformio.org/en/stable/projectconf.html
    #

-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
    [env:arduino_uno]
    platform = atmelavr
    framework = arduino
--- a/docs/ide/sublimetext.rst
+++ b/docs/ide/sublimetext.rst
@ -167,15 +167,12 @@ Copy the source code which is described below to it.
 .. code-block:: none

    #
-    # Project Configuration File
+    # PlatformIO Project Configuration File
    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
+    # Please make sure to read documentation with examples first
+    # http://docs.platformio.org/en/stable/projectconf.html
    #

-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
    [env:arduino_uno]
    platform = atmelavr
    framework = arduino
--- a/docs/ide/visualstudio.rst
+++ b/docs/ide/visualstudio.rst
@ -20,7 +20,7 @@ Refer to the `Visual Studio Documentation <https://msdn.microsoft.com/library/vs
 page for more detailed information.

 .. image:: ../_static/ide-vs-platformio-newproject-8.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-vs-platformio-newproject-8.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-vs-platformio-newproject-8.png

 .. contents::

@ -127,15 +127,12 @@ Copy the source code which is described below to it.
 .. code-block:: none

    #
-    # Project Configuration File
+    # PlatformIO Project Configuration File
    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
+    # Please make sure to read documentation with examples first
+    # http://docs.platformio.org/en/stable/projectconf.html
    #

-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
    [env:arduino_uno]
    platform = atmelavr
    framework = arduino
@ -175,4 +172,4 @@ disable IntelliSense error reporting at all.
 See details in `issue #543 <https://github.com/platformio/platformio/issues/543>`_

 .. image:: ../_static/ide-vs-platformio-newproject-9.png
-    :target: http://docs.platformio.org/en/latest/_static/ide-vs-platformio-newproject-9.png
+    :target: http://docs.platformio.org/en/stable/_static/ide-vs-platformio-newproject-9.png
--- a/docs/platforms/creating_platform.rst
+++ b/docs/platforms/creating_platform.rst
@ -143,6 +143,9 @@ Packages
    * - ``tool-scons``
      - `SCons software construction tool <http://www.scons.org>`_

+    * - ``tool-sreccat``
+      - `Merging tool <https://github.com/marcows/SRecord>`_
+
    * - ``tool-stlink``
      - `ST-Link <https://github.com/texane/stlink>`_

--- a/docs/platforms/nordicnrf51.rst
+++ b/docs/platforms/nordicnrf51.rst
@ -37,6 +37,9 @@ Packages
    * - ``toolchain-gccarmnoneeabi``
      - `gcc-arm-embedded <https://launchpad.net/gcc-arm-embedded>`_, `GDB <http://www.gnu.org/software/gdb/>`_

+    * - ``tool-sreccat``
+      - `Merging tool <https://github.com/marcows/SRecord>`_
+
    * - ``framework-arduinonordicnrf51``
      - `Arduino Wiring-based Framework (RFduino Core) <https://github.com/RFduino/RFduino>`_

--- a/docs/quickstart.rst
+++ b/docs/quickstart.rst
@ -146,24 +146,12 @@ The result of just generated ``platformio.ini``:
 .. code-block:: ini

    #
-    # Project Configuration File
+    # PlatformIO Project Configuration File
    #
-    # A detailed documentation with the EXAMPLES is located here:
-    # http://docs.platformio.org/en/latest/projectconf.html
+    # Please make sure to read documentation with examples first
+    # http://docs.platformio.org/en/stable/projectconf.html
    #

-    # A sign `#` at the beginning of the line indicates a comment
-    # Comment lines are ignored.
-
-    # Simple and base environment
-    # [env:mybaseenv]
-    # platform = %INSTALLED_PLATFORM_NAME_HERE%
-    # framework =
-    # board =
-    #
-    # Automatic targets - enable auto-uploading
-    # targets = upload
-
    [env:uno]
    platform = atmelavr
    framework = arduino
--- a/docs/userguide/cmd_serialports.rst
+++ b/docs/userguide/cmd_serialports.rst
@ -207,14 +207,11 @@ default ``20`` (DEC)

 Diagnostics: suppress non-error messages, default ``Off``

-
 .. option::
    --echo

 Enable local echo, default ``Off``

-**REMOVED**: Is not available in Miniterm/PySerial 3.0
-
 .. option::
    --cr

--- a/platformio/main.py
+++ b/platformio/main.py
@ -116,7 +116,7 @@ An unexpected error occurred. Further steps:
  `pip install -U platformio` command

 * Try to find answer in FAQ Troubleshooting section
-  http://docs.platformio.org/en/latest/faq.html
+  http://docs.platformio.org/en/stable/faq.html

 * Report this problem to the developers
  https://github.com/platformio/platformio/issues
--- a/platformio/app.py
+++ b/platformio/app.py
@ -50,7 +50,7 @@ DEFAULT_SETTINGS = {
    },
    "enable_telemetry": {
        "description": (
-            "Telemetry service <http://docs.platformio.org/en/latest/"
+            "Telemetry service <http://docs.platformio.org/en/stable/"
            "userguide/cmd_settings.html?#enable-telemetry> (Yes/No)"),
        "value": True
    },
--- a/platformio/builder/tools/piomisc.py
+++ b/platformio/builder/tools/piomisc.py
@ -145,17 +145,16 @@ def DumpIDEData(env):

    def get_includes(env_):
        includes = []
-        # includes from used frameworks and libs
-        for item in env_.get("VARIANT_DIRS", []):
-            if "$BUILDSRC_DIR" in item[0]:
-                continue
-            includes.append(env_.subst(item[1]))

-        # custom includes
        for item in env_.get("CPPPATH", []):
-            if item.startswith("$BUILD_DIR"):
-                continue
-            includes.append(env_.subst(item))
+            invardir = False
+            for vardiritem in env_.get("VARIANT_DIRS", []):
+                if item == vardiritem[0]:
+                    includes.append(env_.subst(vardiritem[1]))
+                    invardir = True
+                    break
+            if not invardir:
+                includes.append(env_.subst(item))

        # installed libs
        for lb in env.GetLibBuilders():
--- a/platformio/commands/init.py
+++ b/platformio/commands/init.py
@ -190,7 +190,7 @@ include paths and build them.

 See additional options for PlatformIO Library Dependency Finder `lib_*`:

-http://docs.platformio.org/en/latest/projectconf.html#lib-install
+http://docs.platformio.org/en/stable/projectconf.html#lib-install

 """)

@ -201,7 +201,7 @@ def init_ci_conf(project_dir):
    with open(join(project_dir, ".travis.yml"), "w") as f:
        f.write("""# Continuous Integration (CI) is the practice, in software
 # engineering, of merging all developer working copies with a shared mainline
-# several times a day < http://docs.platformio.org/en/latest/ci/index.html >
+# several times a day < http://docs.platformio.org/en/stable/ci/index.html >
 #
 # Documentation:
 #
@ -209,10 +209,10 @@ def init_ci_conf(project_dir):
 #   < https://docs.travis-ci.com/user/integration/platformio/ >
 #
 # * PlatformIO integration with Travis CI
-#   < http://docs.platformio.org/en/latest/ci/travis.html >
+#   < http://docs.platformio.org/en/stable/ci/travis.html >
 #
 # * User Guide for `platformio ci` command
-#   < http://docs.platformio.org/en/latest/userguide/cmd_ci.html >
+#   < http://docs.platformio.org/en/stable/userguide/cmd_ci.html >
 #
 #
 # Please choice one of the following templates (proposed below) and uncomment
--- a/platformio/commands/serialports.py
+++ b/platformio/commands/serialports.py
@ -61,6 +61,8 @@ if int(PYSERIAL_VERSION[0]) == 3:
                  help="Set initial RTS line state")
    @click.option("--dtr", default=None, type=click.Choice(["0", "1"]),
                  help="Set initial DTR line state")
+    @click.option("--echo", is_flag=True,
+                  help="Enable local echo, default=Off")
    @click.option("--encoding", default="UTF-8",
                  help="Set the encoding for the serial port (e.g. hexlify, "
                  "Latin1, UTF-8), default: UTF-8")
--- a/platformio/commands/upgrade.py
+++ b/platformio/commands/upgrade.py
@ -65,7 +65,7 @@ def cli():
                "PlatformIO has been successfully upgraded to %s" %
                actual_version, fg="green")
            click.echo("Release notes: ", nl=False)
-            click.secho("http://docs.platformio.org/en/latest/history.html",
+            click.secho("http://docs.platformio.org/en/stable/history.html",
                        fg="cyan")
        except Exception as e:  # pylint: disable=W0703
            if not r:
--- a/platformio/exception.py
+++ b/platformio/exception.py
@ -191,7 +191,7 @@ class UpgradeError(PlatformioException):

 * Upgrade using `pip install -U platformio`
 * Try different installation/upgrading steps:
-  http://docs.platformio.org/en/latest/installation.html
+  http://docs.platformio.org/en/stable/installation.html
 """


--- a/platformio/projectconftpl.ini
+++ b/platformio/projectconftpl.ini
@ -1,6 +1,6 @@
 #
 # PlatformIO Project Configuration File
 #
-# Please check documentation with examples
-# http://docs.platformio.org/en/latest/projectconf.html
-#
+# Please make sure to read documentation with examples first
+# http://docs.platformio.org/en/stable/projectconf.html
+#
--- a/platformio/util.py
+++ b/platformio/util.py
@ -228,7 +228,7 @@ def get_projectpioenvs_dir():
        with open(dontmod_path, "w") as fp:
            fp.write("""
 [InternetShortcut]
-URL=http://docs.platformio.org/en/latest/projectconf.html#envs-dir
+URL=http://docs.platformio.org/en/stable/projectconf.html#envs-dir
 """)
    return path

--- a/scripts/99-platformio-udev.rules
+++ b/scripts/99-platformio-udev.rules
@ -60,7 +60,7 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="16d0", ATTRS{idProduct}=="0753", MODE:="066
 KERNEL=="ttyACM*", ATTRS{idVendor}=="16d0", ATTRS{idProduct}=="0753", MODE:="0666", ENV{ID_MM_DEVICE_IGNORE}="1"

 # STM32 discovery boards, with onboard st/linkv2
-SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="3748", MODE:="0666"
+SUBSYSTEMS=="usb", ATTRS{idVendor}=="0483", ATTRS{idProduct}=="374?", MODE:="0666"

 # USBtiny
 SUBSYSTEMS=="usb", ATTRS{idProduct}=="0c9f", ATTRS{idVendor}=="1781", MODE="0666"