forked from platformio/platformio-core
Rename "lib_compat_level" to "lib_compat_mode"
This commit is contained in:
1 parent
74af8a5c39
commit
22e67e6fdd
5 files changed
+15
-15
No files matched your search
+2
-2
@@ -57,12 +57,12 @@ order:
|
||||
2. :ref:`projectconf_pio_lib_dir`
|
||||
3. :ref:`projectconf_pio_home_dir`/lib
|
||||
|
||||
Library Dependency Finder has a few key factors from :ref:`projectconf`:
|
||||
Library Dependency Finder has a few controls from :ref:`projectconf`:
|
||||
|
||||
* :ref:`projectconf_lib_ignore`
|
||||
* :ref:`projectconf_lib_deep_search`
|
||||
* :ref:`projectconf_lib_extra_dirs`
|
||||
* :ref:`projectconf_lib_compat_level`
|
||||
* :ref:`projectconf_lib_compat_mode`
|
||||
|
||||
Command completion in Terminal
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
@@ -729,25 +729,25 @@ Example:
|
||||
[env:custom_lib_dirs]
|
||||
lib_extra_dirs = /path/to/private/dir1,/path/to/private/dir2
|
||||
|
||||
.. _projectconf_lib_compat_level:
|
||||
.. _projectconf_lib_compat_mode:
|
||||
|
||||
``lib_compat_level``
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
``lib_compat_mode``
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Please make sure to read :ref:`faq_ldf` guides first.
|
||||
|
||||
Library compatibility level that allows to control Library Dependency Finder
|
||||
Library compatibility mode that allows to control Library Dependency Finder
|
||||
strictness. If library contains manifest file (:ref:`library_config`,
|
||||
``library.properties``, ``module.json``), then LDF check compatibility of this
|
||||
library with real build environment. Available compatibility levels:
|
||||
library with real build environment. Available compatibility modes:
|
||||
|
||||
* ``0`` - don't check for compatibility (disable)
|
||||
* ``0`` - don't check for compatibility
|
||||
* ``1`` - check for the compatibility with :ref:`projectconf_env_framework`
|
||||
from build environment
|
||||
* ``2`` - check for the compatibility with :ref:`projectconf_env_framework`
|
||||
and :ref:`projectconf_env_platform` from build environment.
|
||||
|
||||
By default, this value is set to ``lib_compat_level = 1`` and means that LDF
|
||||
By default, this value is set to ``lib_compat_mode = 1`` and means that LDF
|
||||
will check only for framework compatibility.
|
||||
|
||||
-----------
|
||||
|
||||
Reference in new issue
Block a user