platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-29 17:47:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Explain how to use "uploading" with CI command // Resolve #686

Browse Source
This commit is contained in:
Ivan Kravets
2016-08-13 10:33:03 +03:00
parent d28e8a06b5
commit 317c7272cd
2 changed files with 26 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/projectconf.rst
View File

@ -553,6 +553,8 @@ Example, specify own upload command for :ref:`platform_atmelavr`:
- `#351 Specific reset method for ESP8266 <https://github.com/platformio/platformio/issues/351#issuecomment-161789165>`_
- `#247 Specific options for avrdude <https://github.com/platformio/platformio/issues/247#issuecomment-118169728>`_.
.. _projectconf_targets:
``targets``
^^^^^^^^^^^

33
docs/userguide/cmd_ci.rst
View File

@ -35,19 +35,34 @@ with the build environments (using :option:`platformio ci --board` or
:option:`platformio ci --project-conf`) and processes them via :ref:`cmd_run`
command.
:ref:`cmd_ci` command accepts **multiple** ``SRC`` arguments,
:option:`platformio ci --lib` and :option:`platformio ci --exclude` options
which can be a path to directory, file or
`Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_.
Also, you can omit ``SRC`` argument and set path (multiple paths are allowed
denoting with ``:``) to
``PLATFORMIO_CI_SRC`` `Environment variable <http://en.wikipedia.org/wiki/Environment_variable>`_
For more details as for integration with the popular Continuous Integration
Systems please follow to :ref:`ci` page.
.. note::
:ref:`cmd_ci` command accepts **multiple** ``SRC`` arguments,
:option:`platformio ci --lib` and :option:`platformio ci --exclude` options
which can be a path to directory, file or
`Glob Pattern <http://en.wikipedia.org/wiki/Glob_(programming)>`_.
:ref:`cmd_ci` command is useful for library developers. It allows to build
different examples without creating own project per them. Also, is possible
to upload firmware to the target device. In this case, need to create
:ref:`projectconf` where specify "upload" :ref:`projectconf_targets`. Custom
upload port can be overridden with :ref:`projectconf_upload_port` option.
Then need to specify the path to this :ref:`projectconf` to
:option:`platformio ci --project-conf`. For example,
.. note::
You can omit ``SRC`` argument and set path (multiple paths are allowed
denoting with ``:``) to
``PLATFORMIO_CI_SRC`` `Environment variable <http://en.wikipedia.org/wiki/Environment_variable>`_
.. code-block:: ini
[env:uno]
platform = atmelavr
framework = arduino
targets = upload
; custom upload port
; upload_port = ...
Options
-------
@ -120,4 +135,4 @@ or by environment variable :envvar:`PLATFORMIO_SETTING_FORCE_VERBOSE`.
Examples
--------
For the examples please follow to :ref:`ci` page.
For the others examples please follow to :ref:`ci` page.