Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
Angus Gratton 2016-09-16 18:22:16 +10:00
parent 90017397e5
commit 6cf5d44b31
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/build_system.rst
View file

@ -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 they can also reside in an other folder), the path to this may be
something like /home/myuser/projects/myprojects/components/httpd . 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, One of the things that most components will have is a component.mk makefile,
containing instructions on how to build the component. Because the containing instructions on how to build the component. Because the
build environment tries to set reasonable defaults that will work most 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 Simplest component.mk
===================== =====================