From 6cf5d44b31789beafcacd5f74e337bea09206e04 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Fri, 16 Sep 2016 18:22:16 +1000 Subject: [PATCH] build system docs: Add note about no spaces in component names --- docs/build_system.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/build_system.rst b/docs/build_system.rst index 43055a4787..4df65b1b5c 100644 --- a/docs/build_system.rst +++ b/docs/build_system.rst @@ -193,10 +193,13 @@ Because components usually live under the project directory (although they can also reside in an other folder), the path to this may be something like /home/myuser/projects/myprojects/components/httpd . +Components can have any name (unique to the project) but the name +cannot contain spaces (esp-idf does not support spaces in paths). + One of the things that most components will have is a component.mk makefile, containing instructions on how to build the component. Because the build environment tries to set reasonable defaults that will work most -of the time, component.mk can be very small. +of the time, component.mk can be very small. Simplest component.mk =====================