aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAngelo Compagnucci <angelo@amarulasolutions.com>2017-12-06 10:12:07 +0100
committerJean Delvare <jdelvare@suse.de>2017-12-06 10:12:07 +0100
commit2580c969ae2cc2b0a3758656fffa566e772efb4b (patch)
tree36205bcdc55ba805418ec34644b7a49db31c5e47
parent9906b2ecb6aec02d6348d6237b784135e6930d0b (diff)
downloadi2c-tools-2580c969ae2cc2b0a3758656fffa566e772efb4b.tar.gz
README: Add documentation for BUILD_DYNAMIC_LIB
Document the newly introduced BUILD_DYNAMIC_LIB flag and clarify the use of the other variables USE_STATIC_LIB and BUILD_STATIC_LIB. [JD: Edit] Signed-off-by: Angelo Compagnucci <angelo@amarulasolutions.com> Signed-off-by: Jean Delvare <jdelvare@suse.de>
-rw-r--r--README14
1 files changed, 12 insertions, 2 deletions
diff --git a/README b/README
index 4ccdf5b..2aaf927 100644
--- a/README
+++ b/README
@@ -63,8 +63,18 @@ tools, and "make install" to install them. You also can use "make uninstall"
to remove all the files you installed. By default, files are installed in
/usr/local but you can change the location by editing the Makefile file and
setting prefix to wherever you want. You may change the C compiler and the
-compilation flags as well, and also decide whether to build the static
-library or not.
+compilation flags as well, and also decide which flavors of the library
+will be built.
+
+In cases where you need to compile only the static or dynamic variant of
+the library, you can use BUILD_STATIC_LIB and BUILD_DYNAMIC_LIB at compile
+time:
+ $ make BUILD_DYNAMIC_LIB=1 BUILD_STATIC_LIB=0
+If you disable both, the compilation will abort with an error message.
+
+If you want to compile the tools against the static version of the library
+you can do:
+ $ make USE_STATIC_LIB=1
Optionally, you can run "make strip" prior to "make install" if you want
smaller binaries. However, be aware that this will prevent any further