forked from platformio/platformio-core
Improve docs for library.json build
field
This commit is contained in:
@@ -284,8 +284,8 @@ reduce size of the final archive.
|
|||||||
|
|
||||||
Possible options:
|
Possible options:
|
||||||
|
|
||||||
* ``include``
|
.. contents::
|
||||||
* ``exclude``
|
:local:
|
||||||
|
|
||||||
``include``
|
``include``
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
@@ -483,39 +483,55 @@ A list of example patterns. This field is predefined with default value:
|
|||||||
.. _libjson_build:
|
.. _libjson_build:
|
||||||
|
|
||||||
``build``
|
``build``
|
||||||
------------
|
---------
|
||||||
|
|
||||||
*Optional* | Type: ``Object``
|
*Optional* | Type: ``Object``
|
||||||
|
|
||||||
Specify advanced settings, options and flags for the build system. Possible
|
Specify advanced settings, options and flags for the build system. Possible
|
||||||
options:
|
options:
|
||||||
|
|
||||||
.. list-table::
|
.. contents::
|
||||||
:header-rows: 1
|
:local:
|
||||||
|
|
||||||
* - Option
|
``flags``
|
||||||
- Type
|
~~~~~~~~~
|
||||||
- Description
|
|
||||||
* - ``flags``
|
*Optional* | Type: ``String`` or ``Array``
|
||||||
- ``String`` or ``Array``
|
|
||||||
- Extra flags to control preprocessing, compilation, assembly and
|
Extra flags to control preprocessing, compilation, assembly and linking
|
||||||
linking processes. More details :ref:`projectconf_build_flags`
|
processes. More details :ref:`projectconf_build_flags`.
|
||||||
* - ``unflags``
|
|
||||||
- ``String`` or ``Array``
|
``unflags``
|
||||||
- Remove base/initial flags which were set by development
|
~~~~~~~~~~~
|
||||||
platform. More details :ref:`projectconf_build_unflags`
|
|
||||||
* - ``srcFilter``
|
*Optional* | Type: ``String`` or ``Array``
|
||||||
- ``String`` or ``Array``
|
|
||||||
- Specify which source files should be included/excluded
|
Remove base/initial flags which were set by development platform. More
|
||||||
from build process. More details :ref:`projectconf_src_filter`
|
details :ref:`projectconf_build_unflags`.
|
||||||
* - ``extraScript``
|
|
||||||
- ``String``
|
``srcFilter``
|
||||||
- Launch extra script before build process.
|
~~~~~~~~~~~~~
|
||||||
More details :ref:`projectconf_extra_script`
|
|
||||||
* - ``libArchive``
|
*Optional* | Type: ``String`` or ``Array``
|
||||||
- ``Boolean``
|
|
||||||
- Archive object files to Static Library. This is default behavior of
|
Specify which source files should be included/excluded from build process.
|
||||||
PlatformIO Build System (``"libArchive": true``).
|
More details :ref:`projectconf_src_filter`.
|
||||||
|
|
||||||
|
``extraScript``
|
||||||
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
*Optional* | Type: ``String``
|
||||||
|
|
||||||
|
Launch extra script before build process.
|
||||||
|
More details :ref:`projectconf_extra_script`.
|
||||||
|
|
||||||
|
``libArchive``
|
||||||
|
~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
*Optional* | Type: ``Boolean``
|
||||||
|
|
||||||
|
Archive object files to Static Library. This is default behavior of PlatformIO
|
||||||
|
Build System (``"libArchive": true``).
|
||||||
|
|
||||||
**Examples**
|
**Examples**
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user