Merge branch 'release/v1.1.0'

HISTORY.rst

@@ -1,7 +1,25 @@
 Release History
 ===============
 
-1.0.0 (2015-02-27)
+1.1.0 (2015-03-05)
+------------------
+
+* Implemented ``PLATFORMIO_*`` environment variables
+  (`issue #102 <https://github.com/ivankravets/platformio/issues/102>`_)
+* Added support for *SainSmart* boards to
+  `atmelsam <http://docs.platformio.org/en/latest/platforms/atmelsam.html#boards>`__
+  development platform
+* Added
+  `Project Configuration <http://docs.platformio.org/en/latest/projectconf.html>`__
+  option named `envs_dir <http://docs.platformio.org/en/latest/projectconf.html#envs-dir>`__
+* Disabled "prompts" automatically for *Continuous Integration* systems
+  (`issue #103 <https://github.com/ivankravets/platformio/issues/103>`_)
+* Fixed firmware uploading for
+  `atmelavr <http://docs.platformio.org/en/latest/platforms/atmelavr.html#boards>`__
+  boards which work within ``usbtiny`` protocol
+* Fixed uploading for *Digispark* board (`issue #106 <https://github.com/ivankravets/platformio/issues/106>`_)
+
+1.0.1 (2015-02-27)
 ------------------
 
 **PlatformIO 1.0 - recommended for production**
@@ -219,7 +237,7 @@ Release History
   `srcbuild_flags <http://docs.platformio.org/en/latest/projectconf.html#srcbuild-flags>`_
   environment option
 * Allowed to override some of settings via system environment variables
-  such as: ``$PIOSRCBUILD_FLAGS`` and ``$PIOENVS_DIR``
+  such as: ``PLATFORMIO_SRCBUILD_FLAGS`` and ``PLATFORMIO_ENVS_DIR``
 * Added ``--upload-port`` option for `platformio run <http://docs.platformio.org/en/latest/userguide/cmd_run.html#cmdoption--upload-port>`__ command
 * Implemented (especially for `SmartAnthill <http://docs.smartanthill.ikravets.com/>`_)
   `platformio run -t uploadlazy <http://docs.platformio.org/en/latest/userguide/cmd_run.html>`_

docs/envvars.rst

@@ -0,0 +1,120 @@
+.. _envvars:
+
+Environment variables
+=====================
+
+`Environment variables <http://en.wikipedia.org/wiki/Environment_variable>`_
+are a set of dynamic named values that can affect the way running processes
+will behave on a computer.
+
+*PlatformIO* handles variables which start with ``PLATFORMIO_`` prefix. They
+have the **HIGHEST PRIORITY**.
+
+.. contents::
+
+General
+-------
+
+PlatformIO uses *General* environment variables for the common
+operations/commands.
+
+.. _envvar_CI:
+
+CI
+~~
+
+PlatformIO handles ``CI`` variable which is setup by
+`Continuous Integration <http://en.wikipedia.org/wiki/Continuous_integration>`_
+(Travis, Circle and etc.) systems.
+Currently, PlatformIO uses it to disable prompts.
+
+In other words, ``CI=true`` automatically setup
+:ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=false <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`.
+
+.. _envvar_PLATFORMIO_HOME_DIR:
+
+PLATFORMIO_HOME_DIR
+~~~~~~~~~~~~~~~~~~~
+
+Allows to override :ref:`projectconf` option
+:ref:`projectconf_pio_home_dir`.
+
+.. _envvar_PLATFORMIO_LIB_DIR:
+
+PLATFORMIO_LIB_DIR
+~~~~~~~~~~~~~~~~~~
+
+Allows to override :ref:`projectconf` option
+:ref:`projectconf_pio_lib_dir`.
+
+.. _envvar_PLATFORMIO_SRC_DIR:
+
+PLATFORMIO_SRC_DIR
+~~~~~~~~~~~~~~~~~~
+
+Allows to override :ref:`projectconf` option
+:ref:`projectconf_pio_src_dir`.
+
+.. _envvar_PLATFORMIO_ENVS_DIR:
+
+PLATFORMIO_ENVS_DIR
+~~~~~~~~~~~~~~~~~~~
+
+Allows to override :ref:`projectconf` option
+:ref:`projectconf_pio_envs_dir`.
+
+
+Builder
+-------
+
+.. _envvar_PLATFORMIO_SRCBUILD_FLAGS:
+
+PLATFORMIO_SRCBUILD_FLAGS
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override :ref:`projectconf` option
+:ref:`projectconf_srcbuild_flags`.
+
+Settings
+--------
+
+Allows to override PlatformIO settings. You can manage them via
+:ref:`cmd_settings` command.
+
+
+PLATFORMIO_SETTING_AUTO_UPDATE_LIBRARIES
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`auto_update_libraries`.
+
+PLATFORMIO_SETTING_AUTO_UPDATE_PLATFORMS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`auto_update_platforms`.
+
+PLATFORMIO_SETTING_CHECK_LIBRARIES_INTERVAL
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`check_libraries_interval`.
+
+PLATFORMIO_SETTING_CHECK_PLATFORMIO_INTERVAL
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`check_platformio_interval`.
+
+PLATFORMIO_SETTING_CHECK_PLATFORMS_INTERVAL
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`check_platforms_interval`.
+
+.. _envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS:
+
+PLATFORMIO_SETTING_ENABLE_PROMPTS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`enable_prompts`.
+
+PLATFORMIO_SETTING_ENABLE_TELEMETRY
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows to override setting :option:`enable_telemetry`.

docs/index.rst

@@ -57,6 +57,7 @@ Contents
     quickstart
     installation
     projectconf
+    envvars
     platforms/index
     librarymanager/index
     userguide/index

docs/installation.rst

@@ -30,9 +30,14 @@ application:
   application.
 
 .. warning::
-    If you are going to use *PlatformIO* for "*Cloud Compiling*", please
-    don't forget to turn off :ref:`enable_prompts <cmd_settings>` setting. It
-    will allow you to avoid blocking when call ``platformio`` like subprocess.
+    If you are going to run *PlatformIO* from **subprocess**, you **MUST
+    DISABLE** all prompts. It will allow you to avoid blocking.
+    There are a few options:
+
+    - using environment variable :ref:`PLATFORMIO_SETTING_ENABLE_PROMPTS=No <envvar_PLATFORMIO_SETTING_ENABLE_PROMPTS>`
+    - disable global setting ``enable_prompts`` via :ref:`cmd_settings` command
+    - masking under Continuous Integration system via environment variable
+      :ref:`CI=true <envvar_CI>`.
 
 Please *choose one of* the following:
 

docs/platforms/atmelsam.rst

@@ -70,7 +70,13 @@ Boards
       - Flash
       - RAM
     * - ``due``
-      - `Arduino Due <http://arduino.cc/en/Main/arduinoBoardDue>`_
+      - `Arduino Due (Programming Port) <http://arduino.cc/en/Main/arduinoBoardDue>`_
+      - at91sam3x8e ``cortex-m3``
+      - 84 MHz ``84000000L``
+      - 512 Kb
+      - 32 Kb
+    * - ``dueUSB``
+      - `Arduino Due (USB Native Port) <http://arduino.cc/en/Main/arduinoBoardDue>`_
       - at91sam3x8e ``cortex-m3``
       - 84 MHz ``84000000L``
       - 512 Kb
@@ -81,6 +87,18 @@ Boards
       - 84 MHz ``84000000L``
       - 512 kb
       - 32 Kb
+    * - ``sainSmartDue``
+      - `SainSmart Due (Programming Port) <http://www.sainsmart.com/arduino/control-boards/sainsmart-due-atmel-sam3x8e-arm-cortex-m3-board-black.html>`_
+      - at91sam3x8e ``cortex-m3``
+      - 84 MHz ``84000000L``
+      - 512 Kb
+      - 32 Kb
+    * - ``sainSmartDueUSB``
+      - `SainSmart Due (USB Native Port) <http://www.sainsmart.com/arduino/control-boards/sainsmart-due-atmel-sam3x8e-arm-cortex-m3-board-black.html>`_
+      - at91sam3x8e ``cortex-m3``
+      - 84 MHz ``84000000L``
+      - 512 Kb
+      - 32 Kb
 
 More detailed information you can find here
 `Atmel SMART ARM-based MCUs <http://www.atmel.com/products/microcontrollers/arm/default.aspx>`_.

docs/platforms/index.rst

@@ -17,7 +17,7 @@ MCU, upload protocol or etc. Please use ``board`` option.
     atmelavr
     atmelsam
     stm32
+    teensy
     timsp430
     titiva
-    teensy
     creating_platform