From 5492ba759a0fff6276b86c074e235d4f83dd7896 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Wed, 21 Jun 2017 15:13:15 +1000 Subject: [PATCH] build system docs: Add some notes about project-level variables --- docs/api-guides/build-system.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api-guides/build-system.rst b/docs/api-guides/build-system.rst index 7336085c3..2a2800bbc 100644 --- a/docs/api-guides/build-system.rst +++ b/docs/api-guides/build-system.rst @@ -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. - ``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 -------------------