Allow passing custom project configuration options to `platformio ci and platformio init commands using -O, --project-option`.
This commit is contained in:
+15
-15
@@ -49,20 +49,11 @@ Systems please follow to :ref:`ci` page.
|
||||
.. note::
|
||||
: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,
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
[env:uno]
|
||||
platform = atmelavr
|
||||
framework = arduino
|
||||
targets = upload
|
||||
; custom upload port
|
||||
; upload_port = ...
|
||||
to upload firmware to the target device. In this case, you need to pass
|
||||
additional option ``--project-option="targets=upload"``. What is more,
|
||||
you can specify custom upload port using
|
||||
``--project-option="upload_port=<port>"`` option.
|
||||
See :option:`platformio ci --project-option` for details.
|
||||
|
||||
Options
|
||||
-------
|
||||
@@ -120,10 +111,19 @@ temporary directory within your operation system.
|
||||
Don't remove :option:`platformio ci --build-dir` after build process.
|
||||
|
||||
.. option::
|
||||
--project-conf
|
||||
-P, --project-conf
|
||||
|
||||
Buid project using pre-configured :ref:`projectconf`.
|
||||
|
||||
.. option::
|
||||
-O, --project-option
|
||||
|
||||
Pass additional options from :ref:`projectconf` to
|
||||
:option:`platformio init --project-option` command. For example,
|
||||
automatically install dependent libraries
|
||||
``platformio ci --project-option="lib_deps=ArduinoJSON"`` or ignore specific
|
||||
library ``platformio ci --project-option="lib_ignore=SomeLib"``.
|
||||
|
||||
.. option::
|
||||
-v, --verbose
|
||||
|
||||
|
||||
@@ -65,18 +65,17 @@ The full list with pre-configured boards is available here :ref:`platforms`.
|
||||
.. option::
|
||||
--ide
|
||||
|
||||
Initialise PlatformIO project for the specified IDE which can be imported later
|
||||
Initialize PlatformIO project for the specified IDE which can be imported later
|
||||
via "Import Project" functionality.
|
||||
|
||||
A list with supported IDE is available within ``platformio init --help`` command.
|
||||
Also, please take a look at :ref:`ide` page.
|
||||
|
||||
.. option::
|
||||
--enable-auto-uploading
|
||||
-O, --project-option
|
||||
|
||||
If you initialise project with the specified
|
||||
:option:`platformio init --board`, then *PlatformIO*
|
||||
will create environment with enabled firmware auto-uploading.
|
||||
Initialize project with additional options from :ref:`projectconf`. For example,
|
||||
``platformio init --project-option="lib_deps=ArduinoJSON"``.
|
||||
|
||||
.. option::
|
||||
--env-prefix
|
||||
@@ -104,7 +103,6 @@ Examples
|
||||
platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
|
||||
src - Put your source files here
|
||||
lib - Put here project specific (private) libraries
|
||||
Do you want to continue? [y/N]: y
|
||||
Project has been successfully initialized!
|
||||
Useful commands:
|
||||
`platformio run` - process/build project from the current directory
|
||||
@@ -122,14 +120,13 @@ Examples
|
||||
platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
|
||||
src - Put your source files here
|
||||
lib - Put here project specific (private) libraries
|
||||
Do you want to continue? [y/N]: y
|
||||
Project has been successfully initialized!
|
||||
Useful commands:
|
||||
`platformio run` - process/build project from the current directory
|
||||
`platformio run --target upload` or `platformio run -t upload` - upload firmware to embedded board
|
||||
`platformio run --target clean` - clean project (remove compiled files)
|
||||
|
||||
3. Initialise project for Arduino Uno
|
||||
3. Initialize project for Arduino Uno
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@@ -143,7 +140,6 @@ Examples
|
||||
platformio.ini - Project Configuration File. |-> PLEASE EDIT ME <-|
|
||||
src - Put your source files here
|
||||
lib - Put here project specific (private) libraries
|
||||
Do you want to continue? [y/N]: y
|
||||
Project has been successfully initialized!
|
||||
Useful commands:
|
||||
`platformio run` - process/build project from the current directory
|
||||
|
||||
Reference in New Issue
Block a user