build system docs: Add some notes about project-level variables

This commit is contained in:
Angus Gratton 2017-06-21 15:13:15 +10:00 committed by Angus Gratton
parent 2571e66a29
commit 5492ba759a

View file

@ -124,6 +124,10 @@ These variables all have default values that can be overridden for custom behavi
- ``EXTRA_COMPONENT_DIRS``: Optional list of additional directories to search for components. - ``EXTRA_COMPONENT_DIRS``: Optional list of additional directories to search for components.
- ``COMPONENTS``: A list of component names to build into the project. Defaults to all components found in the COMPONENT_DIRS directories. - ``COMPONENTS``: A list of component names to build into the project. Defaults to all components found in the COMPONENT_DIRS directories.
Any paths in these Makefile variables should be absolute paths. You can convert relative paths using ``$(PROJECT_PATH)/xxx``, ``$(IDF_PATH)/xxx``, or use the Make function ``$(abspath xxx)``.
These variables should all be set before the line ``include $(IDF_PATH)/make/project.mk`` in the Makefile.
Component Makefiles Component Makefiles
------------------- -------------------