build system docs: Add note about no spaces in component names

This commit is contained in:
Angus Gratton
2016-09-16 18:22:16 +10:00
parent 90017397e5
commit 6cf5d44b31

View File

@@ -193,6 +193,9 @@ 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