VCL-LDPRELOAD: statically link vppcom into libvcl-ldpreload.so

[vpp.git] / extras / vcl-ldpreload / README.md

diff --git a/extras/vcl-ldpreload/README.md b/extras/vcl-ldpreload/README.md
index 0b5378e..e9026c1 100644 (file)
--- a/extras/vcl-ldpreload/README.md
+++ b/extras/vcl-ldpreload/README.md
@@ -1,52 +1,27 @@
 # vcl-ldpreload a LD_PRELOAD library that uses the VPP Communications Library (VCL).
 
 User can LD_PRELOAD any application that uses POSIX socket API.
-This library internally uses libvppcom.so library from VPP project.
 
+NOTE: The sources have been moved to .../vpp/src/vcl and libvcl_ldpreload.so
+      libvcl-ldpreload.so is built with VPP and can be found in
+      .../vpp/build-root/install-vpp[_debug]-native/vpp/lib64
 
 ## HowTo
 
-If VPP is not installed, but rather built in a separate directory, you can use the VPP_DIR 'configure' argument.
-```bash
-# 1. Set environment variables for source
-cd vpp/extras/vcl-ldpreload
-source ./env.sh
-
-# 2. Change to VPP source directory and build
-- Change director and modify uri.am to enable socket_test program
-
-cd $VPP_DIR
-perl -pi -e 's/noinst_PROGRAMS/bin_PROGRAMS/g' $VPP_DIR/src/uri.am
-
-- Build VPP release 
-
-make install-dep wipe-release bootstrap dpdk-install-dev build-release
-
-# 2. Build LD_PRELOAD library against VPP build above
-## This does not install the LD_PRELOAD library in your system.
-## Instead it will be referenced from the build directory set in VCL_LDPRELOAD_LIB
-
-cd $LDP_DIR/vcl-ldpreload/src
-autoreconf -i -f
-./configure VPP_DIR=$VPP_DIR
-make
-```bash
-
-
-# 3. Running the demo
+# 1. Running the demo
 ## Run test script without parameters to see help menu:
 
-cd $VPP_DIR/test/scripts
-./socket_test.sh
+export WS_ROOT=<top level vpp git repo dir>  (e.g. /scratch/my_name/vpp)
+$WS_ROOT/test/scripts/socket_test.sh
 
-# 4. Docker iPerf examples.
+# 2. Docker iPerf examples.
 ## These launch xterms. To quit, close xterms and run following docker kill cmd (WARNING: This will kill all docker containers!) 'docker kill $(docker ps -q)'
 
 
 ## Docker iPerf using default Linux Bridge
 
-./socket_test.sh -bi docker-kernel
+$WS_ROOT/test/scripts/socket_test.sh -bi docker-kernel
 
 ## Docker iPerf using VPP
-./socket_test.sh -bi docker-preload
+$WS_ROOT/test/scripts/socket_test.sh -bi docker-preload