pioduino/platformio-core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PlatformIO Library Manager 3.0 // Resolve #588 , Resolve #414, Resolve #498, Resolve #475, Resolve #410, Resolve #461, Resolve #361, Resolve #507, Resolve #554

Browse Source
This commit is contained in:
Ivan Kravets
2016-08-02 19:10:29 +03:00
parent 5b5a63cb5f
commit 758396c9ea
34 changed files with 1185 additions and 700 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/userguide/platforms/cmd_install.rst
+57 -47
View File
@@ -21,14 +21,18 @@ Usage
.. code-block:: bash
# install platform by name
platformio platform install [OPTIONS] [PLATFORM...]
# install specific platform version using Semantic Versioning
platformio platform install [OPTIONS] PLATFORM@X.Y.Z
# install platform using URL
platformio platform install [OPTIONS] URL
# [PLATFORM...] forms
platformio platform install <name>
platformio platform install <name>@<version>
platformio platform install <name>@<version range>
platformio platform install <zip or tarball url>
platformio platform install file://<zip or tarball file>
platformio platform install file://<folder>
platformio platform install <repository>
platformio platform install <name=repository> (name it should have locally)
platformio platform install <repository#tag> ("tag" can be commit, branch or tag)
Description
@@ -36,33 +40,56 @@ Description
Install :ref:`platforms` and dependent packages.
There are several predefined aliases for packages, such as:
The ``version`` supports `Semantic Versioning <http://semver.org>`_ (
``<major>.<minor>.<patch>``) and can take any of the following forms:
* ``framework``
* ``toolchain``
* ``uploader``
* ``0.1.2`` - an exact version number. Use only this exact version
* ``^0.1.2`` - any compatible version (exact version for ``0.x.x`` versions
* ``~0.1.2`` - any version with the same major and minor versions, and an
equal or greater patch version
* ``>0.1.2`` - any version greater than ``0.1.2``. ``>=``, ``<``, and ``<=``
are also possible
* ``>0.1.0,!=0.2.0,<0.3.0`` - any version greater than ``0.1.0``, not equal to
``0.2.0`` and less than ``0.3.0``
Local
~~~~~
PlatformIO supports installing development platform from local directory or
archive. Need to use ``file://`` prefix before local path. Also, platform
directory or archive should contain ``platform.json`` manifest.
Also, PlatformIO supports installing from local directory or archive. Need to
use ``file://`` prefix before local path. Also, directory or archive should
contain ``platform.json`` manifest.
* ``file:///local/path/to/the/platform/dir``
* ``file:///local/path/to/the/platform.zip``
* ``file:///local/path/to/the/platform.tar.gz``
Remote
~~~~~~
Options
-------
VCS
~~~
.. program:: platformio platform install
.. option::
--with-package
Install specified package (or alias)
.. option::
--without-package
Do not install specified package (or alias)
.. option::
--skip-default
Skip default packages
Version control
---------------
PlatformIO supports installing from Git, Mercurial and Subversion, and detects
the type of VCS using url prefixes: "git+", "hg+", or "svn+".
PlatformIO requires a working VCS command on your path: git, hg or svn.
.. note::
PlatformIO requires a working VCS command on your path: ``git``, ``hg``
or ``svn``.
Git
^^^
@@ -70,6 +97,7 @@ Git
The supported schemes are: ``git``, ``git+https`` and ``git+ssh``. Here are
the supported forms:
* platformio/platform-NAME (short version for GitHub repository)
* https://github.com/platformio/platform-NAME.git
* git+git://git.server.org/my-platform
* git+https://git.server.org/my-platform
@@ -112,35 +140,15 @@ You can also give specific revisions to an SVN URL, like so:
* svn+svn://svn.server.org/my-platform#13
Options
-------
.. program:: platformio platform install
.. option::
--with-package
Install specified package (or alias)
.. option::
--without-package
Do not install specified package (or alias)
.. option::
--skip-default
Skip default packages
Examples
--------
1. Install :ref:`platform_atmelavr` with default packages
.. code-block:: bash
.. code::
> platformio platform install atmelavr
$ platformio platform install atmelavr
PlatformManager: Installing atmelavr
Downloading...
Unpacking [####################################] 100%
@@ -159,7 +167,9 @@ Examples
2. Install :ref:`platform_atmelavr` with ``uploader`` utility only and skip
default packages
.. code-block:: bash
.. code::
> platformio platform install atmelavr --skip-default-package --with-package=uploader
PlatformManager: Installing atmelavr
Downloading [####################################] 100%
@@ -178,9 +188,9 @@ Examples
3. Install the latest development :ref:`platform_atmelavr` from Git repository
.. code-block:: bash
.. code::
$ platformio platform install https://github.com/platformio/platform-atmelavr.git
> platformio platform install https://github.com/platformio/platform-atmelavr.git
PlatformManager: Installing platform-atmelavr
git version 2.7.4 (Apple Git-66)
docs/userguide/platforms/cmd_list.rst
+3 -2
View File
@@ -42,9 +42,10 @@ Return the output in `JSON <http://en.wikipedia.org/wiki/JSON>`_ format
Examples
--------
.. code-block:: bash
.. code::
> platformio platform list
$ platformio platform list
atmelavr ~ Atmel AVR
====================
Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
docs/userguide/platforms/cmd_search.rst
+9 -6
View File
@@ -45,9 +45,10 @@ Examples
1. Print all available development platforms
.. code-block:: bash
.. code::
> platformio platform search
$ platformio platform search
atmelavr ~ Atmel AVR
====================
Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
@@ -75,9 +76,10 @@ Examples
2. Search for TI development platforms
.. code-block:: bash
.. code::
> platformio platform search texas
$ platformio platform search texas
timsp430 ~ TI MSP430
====================
MSP430 microcontrollers (MCUs) from Texas Instruments (TI) are 16-bit, RISC-based, mixed-signal processors designed for ultra-low power. These MCUs offer the lowest power consumption and the perfect mix of integrated peripherals for thousands of applications.
@@ -92,9 +94,10 @@ Examples
Home: http://platformio.org/platforms/titiva
Packages: ldscripts, framework-libopencm3, toolchain-gccarmnoneeabi, tool-lm4flash, framework-energiativa
.. code-block:: bash
.. code::
> platformio platform search framework-mbed
$ platformio platform search framework-mbed
atmelsam ~ Atmel SAM
====================
Atmel | SMART offers Flash- based ARM products based on the ARM Cortex-M0+, Cortex-M3 and Cortex-M4 architectures, ranging from 8KB to 2MB of Flash including a rich peripheral and feature mix.
docs/userguide/platforms/cmd_show.rst
+3 -2
View File
@@ -33,9 +33,10 @@ Show details about the installed :ref:`platforms`
Examples
--------
.. code-block:: bash
.. code::
> platformio platform show atmelavr
$ platformio platform show atmelavr
atmelavr ~ Atmel AVR
====================
Atmel AVR 8- and 32-bit MCUs deliver a unique combination of performance, power efficiency and design flexibility. Optimized to speed time to market-and easily adapt to new ones-they are based on the industrys most code-efficient architecture for C and assembly programming.
docs/userguide/platforms/cmd_uninstall.rst
+2 -2
View File
@@ -36,9 +36,9 @@ Uninstall specified :ref:`platforms`
Examples
--------
.. code-block:: bash
.. code::
$ platformio platform uninstall atmelavr
> platformio platform uninstall atmelavr
Uninstalling platform atmelavr @ 0.0.0: [OK]
Uninstalling package tool-scons @ 2.4.1: [OK]
Uninstalling package toolchain-atmelavr @ 1.40801.0: [OK]
docs/userguide/platforms/cmd_update.rst
+3 -2
View File
@@ -51,9 +51,10 @@ Do not update, only check for new version
Examples
--------
.. code-block:: bash
.. code::
> platformio platform update
$ platformio platform update
Platform atmelavr
--------
Updating atmelavr @ 0.0.0: [Up-to-date]
docs/userguide/platforms/index.rst
+2 -2
View File
@@ -18,8 +18,8 @@ To print all available commands and options use:
.. code-block:: bash
$ platformio platform --help
$ platformio platform COMMAND --help
platformio platform --help
platformio platform COMMAND --help
.. image:: ../../_static/platformio-demo-platforms.gif