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 <noel.eck@intel.com>
This commit is contained in:
Noel Eck 2018-04-17 15:37:12 -07:00
parent 306872619a
commit 8f63914d76

View File

@ -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 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 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 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 cd src/lcd
make install 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 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 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 this you need to use the target name for the python or node module you want to