diff --git a/docs/projectconf.rst b/docs/projectconf.rst index 6ccb5484..16e352d6 100644 --- a/docs/projectconf.rst +++ b/docs/projectconf.rst @@ -553,6 +553,8 @@ Example, specify own upload command for :ref:`platform_atmelavr`: - `#351 Specific reset method for ESP8266 `_ - `#247 Specific options for avrdude `_. +.. _projectconf_targets: + ``targets`` ^^^^^^^^^^^ diff --git a/docs/userguide/cmd_ci.rst b/docs/userguide/cmd_ci.rst index 283744c6..72d647c2 100644 --- a/docs/userguide/cmd_ci.rst +++ b/docs/userguide/cmd_ci.rst @@ -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 `_. +Also, you can omit ``SRC`` argument and set path (multiple paths are allowed +denoting with ``:``) to +``PLATFORMIO_CI_SRC`` `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 `_. + :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 `_ + .. 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.