[openib-general] [PATCH applied] libsdp.conf: documentation update

[Michael S. Tsirkin]

SIMPLE_LIBSDP must be set to a non-zero string. Document that.
Full path in LD_PRELOAD is not a good idea for mixed 64/32 bit environments.
Adding the path to LD_LIBRARY_PATH is a better idea. Document that.

Signed-off-by: Michael S. Tsirkin <mst at mellanox.co.il>

Index: openib/src/userspace/libsdp/libsdp.conf
===================================================================
--- openib/src/userspace/libsdp/libsdp.conf	(revision 4466)
+++ openib/src/userspace/libsdp/libsdp.conf	(working copy)
@@ -66,17 +66,26 @@
 # match_both  program netserver
 # match_both program sshd
 #
-# One more function of  libsdp.so, is using a simple libsdp by setting the
-# envrinoment variable SIMPLE_LIBSDP.  This definition is significantly
-# simpler. It has no configuration and converts all calls to socket(2)
-# with a family of AF_INET and a type of SOCK_STREAM into family of
+# One more function of libsdp.so, is using a simple libsdp by setting the
+# envrinoment variable SIMPLE_LIBSDP to a non-empty value.  This definition is
+# significantly simpler. It has no configuration and converts all calls to
+# socket(2) with a family of AF_INET and a type of SOCK_STREAM into family of
 # AF_INET_SDP. 
 #
 # libsdp.so isn't setup automatically. it can
 # be used in one of 2 ways:
 #
-# 1) LD_PRELOAD environment variable. Setting this to the full path of the
+# 1) LD_PRELOAD environment variable. Setting this to the name of the
 #    library you want to use will cause it to be preloaded.
-# 2) Adding the full path of the library into /etc/ld.so.preload. This will
+# 2) Adding the name of the library into /etc/ld.so.preload. This will
 #    cause the library to be preloaded for every executable that is linked
 #    with libc.
+#
+# The library should be installed in a directory in which the dynamic loader
+# searches for shared libraries (as specified by LD_LIBRARY_PATH,
+# /etc/ld.so.conf, etc).
+# Alternatively, you can specify the full path to the library that
+# you want to use in LD_PRELOAD or /etc/ld.so.preload as described above.
+#
+# The last option cant be used if you have multiple library versions
+# (e.g. 64/32 bit) and want the linker to select between them automatically.

-- 
MST