Merge branch 'develop' into feature/platformio-30

* develop: Install tox manually Simplified documentation for Continuous integration with AppVeyor // Resolve #671 Fix broken links to project examples Add stlink as the default uploader for disco boards // Issue #665 Specify supported types of library repository
2016-05-28 20:42:50 +03:00
parent 426389b255 35a602cfef
commit c73dd60bd1
11 changed files with 40 additions and 311 deletions
@@ -44,142 +44,20 @@ Put ``appveyor.yml`` to the root directory of the GitHub repository.

    build: off
    environment:
-        global:
-            WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
-        matrix:
-            - PLATFORMIO_CI_SRC: "path\\to\\source\\file.c"
-              PLATFORMIO_CI_SRC: "path\\to\\source\\file.ino"
-              PLATFORMIO_CI_SRC: "path\\to\\source\\directory"
-              WINDOWS_SDK_VERSION: "v7.0"
-              PYTHON_HOME: "C:\\Python27-x64"
-              PYTHON_VERSION: "2.7"
-              PYTHON_ARCH: "64"
-        install:
-          - "git submodule update --init --recursive"
-          - "powershell scripts\\appveyor\\install.ps1"
-        before_test:
-          - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
-        test_script:
-          - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N'

+      matrix:
+        - PLATFORMIO_CI_SRC: "path\\to\\source\\file.c"
+        - PLATFORMIO_CI_SRC: "path\\to\\source\\file.ino"
+        - PLATFORMIO_CI_SRC: "path\\to\\source\\directory"

-Then create ``scripts/appveyor`` folder and put these 2 scripts (they are the
-same for the all projects, don't need to modify them):
+    install:
+        - cmd: git submodule update --init --recursive
+        - cmd: SET PATH=%PATH%;C:\Python27\Scripts
+        - cmd: pip install -U platformio

-1. ``scripts/appveyor/install.ps1``:
+    test_script:
+        - cmd: platformio ci --board=TYPE_1 --board=TYPE_2 --board=TYPE_N

-.. code-block:: PowerShell
-
-    $BASE_URL = "https://www.python.org/ftp/python/"
-    $GET_PIP_URL = "https://bootstrap.pypa.io/get-pip.py"
-    $GET_PIP_PATH = "C:\get-pip.py"
-
-
-    function DownloadPython ($python_version, $platform_suffix) {
-        $webclient = New-Object System.Net.WebClient
-        $filename = "python-" + $python_version + $platform_suffix + ".msi"
-        $url = $BASE_URL + $python_version + "/" + $filename
-
-        $basedir = $pwd.Path + "\"
-        $filepath = $basedir + $filename
-        if (Test-Path $filename) {
-            Write-Host "Reusing" $filepath
-            return $filepath
-        }
-
-        # Download and retry up to 5 times in case of network transient errors.
-        Write-Host "Downloading" $filename "from" $url
-        $retry_attempts = 3
-        for($i=0; $i -lt $retry_attempts; $i++){
-            try {
-                $webclient.DownloadFile($url, $filepath)
-                break
-            }
-            Catch [Exception]{
-                Start-Sleep 1
-            }
-       }
-       Write-Host "File saved at" $filepath
-       return $filepath
-    }
-
-
-    function InstallPython ($python_version, $architecture, $python_home) {
-        Write-Host "Installing Python" $python_version "for" $architecture "bit architecture to" $python_home
-        if (Test-Path $python_home) {
-            Write-Host $python_home "already exists, skipping."
-            return $false
-        }
-        if ($architecture -eq "32") {
-            $platform_suffix = ""
-        } else {
-            $platform_suffix = ".amd64"
-        }
-        $filepath = DownloadPython $python_version $platform_suffix
-        Write-Host "Installing" $filepath "to" $python_home
-        $args = "/qn /i $filepath TARGETDIR=$python_home"
-        Write-Host "msiexec.exe" $args
-        Start-Process -FilePath "msiexec.exe" -ArgumentList $args -Wait -Passthru
-        Write-Host "Python $python_version ($architecture) installation complete"
-        return $true
-    }
-
-
-    function InstallPip ($python_home) {
-        $python_path = $python_home + "/python.exe"
-        Write-Host "Installing pip..."
-        $webclient = New-Object System.Net.WebClient
-        $webclient.DownloadFile($GET_PIP_URL, $GET_PIP_PATH)
-        Write-Host "Executing:" $python_path $GET_PIP_PATH
-        Start-Process -FilePath "$python_path" -ArgumentList "$GET_PIP_PATH" -Wait -Passthru
-    }
-
-    function InstallPackage ($python_home, $pkg) {
-        $pip_path = $python_home + "/Scripts/pip.exe"
-        & $pip_path install -U $pkg
-    }
-
-    function main () {
-        InstallPython $env:PYTHON_VERSION $env:PYTHON_ARCH $env:PYTHON_HOME
-        InstallPip $env:PYTHON_HOME
-        InstallPackage $env:PYTHON_HOME setuptools
-        InstallPackage $env:PYTHON_HOME platformio
-    }
-
-    main
-
-2. ``scripts/appveyor/run_with_compiler.cmd``:
-
-.. code-block:: guess
-
-    @ECHO OFF
-
-    SET COMMAND_TO_RUN=%*
-    SET WIN_SDK_ROOT=C:\Program Files\Microsoft SDKs\Windows
-
-    SET MAJOR_PYTHON_VERSION="%PYTHON_VERSION:~0,1%"
-    IF %MAJOR_PYTHON_VERSION% == "2" (
-        SET WINDOWS_SDK_VERSION="v7.0"
-    ) ELSE IF %MAJOR_PYTHON_VERSION% == "3" (
-        SET WINDOWS_SDK_VERSION="v7.1"
-    ) ELSE (
-        ECHO Unsupported Python version: "%MAJOR_PYTHON_VERSION%"
-        EXIT 1
-    )
-
-    IF "%PYTHON_ARCH%"=="64" (
-        ECHO Configuring Windows SDK %WINDOWS_SDK_VERSION% for Python %MAJOR_PYTHON_VERSION% on a 64 bit architecture
-        SET DISTUTILS_USE_SDK=1
-        SET MSSdk=1
-        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Setup\WindowsSdkVer.exe" -q -version:%WINDOWS_SDK_VERSION%
-        "%WIN_SDK_ROOT%\%WINDOWS_SDK_VERSION%\Bin\SetEnv.cmd" /x64 /release
-        ECHO Executing: %COMMAND_TO_RUN%
-        call %COMMAND_TO_RUN% || EXIT 1
-    ) ELSE (
-        ECHO Using default MSVC build environment for 32 bit architecture
-        ECHO Executing: %COMMAND_TO_RUN%
-        call %COMMAND_TO_RUN% || EXIT 1
-    )

 For more details as for PlatformIO build process please look into :ref:`cmd_ci`
 command.
@@ -194,20 +72,16 @@ Examples

    build: off
    environment:
-        global:
-            WITH_COMPILER: "cmd /E:ON /V:ON /C .\\scripts\\appveyor\\run_with_compiler.cmd"
-        matrix:
-            - PLATFORMIO_CI_SRC: "examples\\Bluetooth\\PS3SPP\\PS3SPP.ino"
-              PLATFORMIO_CI_SRC: "examples\\pl2303\\pl2303_gps\\pl2303_gps.ino"
-              WINDOWS_SDK_VERSION: "v7.0"
-              PYTHON_HOME: "C:\\Python27-x64"
-              PYTHON_VERSION: "2.7"
-              PYTHON_ARCH: "64"
-        install:
-          - "git submodule update --init --recursive"
-          - "powershell scripts\\appveyor\\install.ps1"
-        before_test:
-          - cmd: SET PATH=%PATH%;%PYTHON_HOME%;%PYTHON_HOME%\Scripts
-          - cmd: git clone https://github.com/xxxajk/spi4teensy3.git c:\spi4teensy
-        test_script:
-          - '%WITH_COMPILER% %PYTHON_HOME%\\Scripts\\platformio ci --lib="." --lib="c:\spi4teensy" --board=uno --board=teensy31 --board=due'
+
+      matrix:
+        - PLATFORMIO_CI_SRC: "examples\\Bluetooth\\PS3SPP\\PS3SPP.ino"
+        - PLATFORMIO_CI_SRC: "examples\\pl2303\\pl2303_gps\\pl2303_gps.ino"
+
+    install:
+        - cmd: git submodule update --init --recursive
+        - cmd: SET PATH=%PATH%;C:\Python27\Scripts
+        - cmd: pip install -U platformio
+        - cmd: git clone https://github.com/xxxajk/spi4teensy3.git C:\spi4teensy
+
+    test_script:
+        - cmd: platformio ci --lib="." --lib="C:\\spi4teensy" --board=uno --board=teensy31 --board=due
@@ -19,7 +19,7 @@ Demo & Projects
 Project Examples
 ----------------

-Preconfigured demo projects are located in `PlatformIO GitHub <https://github.com/platformio/platformio/tree/develop/examples>`_ repository.
+Preconfigured demo projects are located in `PlatformIO GitHub <https://github.com/platformio/platformio-examples/tree/develop>`_ repository.

 "Blink Project"
 ---------------
@@ -39,7 +39,7 @@ libOpenCM3, etc.*
 * :ref:`ide_atom`
 * `Web 2.0 Library Search <http://platformio.org/lib>`_ |
  `Embedded Boards Explorer <http://platformio.org/boards>`_
-* `Project Examples <https://github.com/platformio/platformio/tree/develop/examples>`_
+* `Project Examples <https://github.com/platformio/platformio-examples/tree/develop>`_
 * `Source Code <https://github.com/platformio/platformio>`_ |
  `Issues <https://github.com/platformio/platformio/issues>`_
 * `Blog <http://www.ikravets.com/category/computer-life/platformio>`_ |
@@ -141,7 +141,7 @@ Examples:
 The repository in which the source code can be found. The field consists for the
 next items:

-* ``type``
+* ``type`` the only "git", "hg" or "svn" are supported
 * ``url``
 * ``branch`` if is not specified, default branch will be used. This field will
  be ignored if tag/release exists with the value of :ref:`libjson_version`.
@@ -610,7 +610,7 @@ Examples

 .. note::
    A full list with project examples can be found in
-    `PlatformIO Repository <https://github.com/platformio/platformio/tree/develop/examples>`_.
+    `PlatformIO Repository <https://github.com/platformio/platformio-examples/tree/develop>`_.

 1. :ref:`platform_atmelavr`: Arduino UNO board with auto pre-configured
   ``board_*`` and ``upload_*`` options (use only ``board`` option) and Arduino
@@ -256,5 +256,5 @@ Arduino Uno:
 Further Reading
 ---------------

-* `Project examples <https://github.com/platformio/platformio/tree/develop/examples>`_
+* `Project examples <https://github.com/platformio/platformio-examples/tree/develop>`_
 * :ref:`userguide` for PlatformIO CLI commands