doc: add documentation of DESTDIR usage in INSTALL and make help

Document the newly introduced DESTDIR option. Signed-off-by: Christian Wiese <[email protected]> Signed-off-by: Daniel Borkmann <[email protected]>
netsniff-ng · Apr 10, 2014 · 104af10 · 104af10
1 parent 049160c
commit 104af10
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/INSTALL b/INSTALL
@@ -171,6 +171,14 @@ build and install the toolkit into prefixed path like:
  $ make PREFIX=<path-prefix-for-package>
  $ make PREFIX=<path-prefix-for-package> install
 
+Additionally to setting the PREFIX you can set DESTDIR if you want to install
+the toolkit outside of your current root filesystem but into an alternative
+path. This is particularly useful when cross-compiling because most likely
+you want to install into a dedicated sandbox or into a mounted root filesystem
+for the target architecture and not into the build hosts root filesystem.
+
+ $ make PREFIX=<path-prefix-for-package> DESTDIR=<alternative-rootfs> install
+
 Thanks for maintaining netsniff-ng in your distribution. Further questions will
 be answered on the public mailing list.
 

diff --git a/Misc b/Misc
@@ -104,6 +104,7 @@ help:
  $(Q)echo " DEBUG=1 / DISTRO=1 - Enable debugging / Build for distros"
  $(Q)echo " HARDENING=1 - Enable GCC hardening of executables"
  $(Q)echo " PREFIX=/path - Install path prefix"
+ $(Q)echo " DESTDIR=/path - Alternative install destination path"
  $(Q)echo " CROSS_COMPILE=/path-prefix - Kernel-like cross-compiling prefix"
  $(Q)echo " CROSS_LD_LIBRARY_PATH=/path - Library search path for cross-compiling"
  $(Q)echo " CC=cgcc - Use sparse compiler wrapper"