From 8f63914d76f8d6ff9971e3a97141012a2d78daf3 Mon Sep 17 00:00:00 2001 From: Noel Eck Date: Tue, 17 Apr 2018 15:37:12 -0700 Subject: [PATCH] docs: Clarification for lib-level 'make-install' While a 'make install' under a target library directory (build/src/lcd) will build all dependencies required to make the target, it will NOT install those dependencies. This can cause confusion for developers. Adding a note to the build docs to clarify this case. Signed-off-by: Noel Eck --- docs/building.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/building.md b/docs/building.md index e26911c8..b550be6e 100644 --- a/docs/building.md +++ b/docs/building.md @@ -96,13 +96,16 @@ You can also generate the include and lib directories containing all the sensor headers and library files respectively with *make install*. Further, you may choose to generate these only for a specific sensor you modified, and this can be achieved by building from the individual makefile of the sensor. Assuming -you're in the build directory, to make the lcd module you would: +you're in the build directory, to build/install the lcd module you would: ~~~~~~~~~~~~~ cd src/lcd make install ~~~~~~~~~~~~~ +Note: 'make install' under src/lcd will build all targets (and dependencies) +for the lcd but will NOT install dependencies. + Often developers are only interested in building one module or even just the python/node module to do some quick testing using scripting. In order to do this you need to use the target name for the python or node module you want to