ports/108739: Update/enhance description of INSTALLS_SHLIB and USE_LDCONFIG

[Gerald Pfeifer]

>Number:         108739
>Category:       ports
>Synopsis:       Update/enhance description of INSTALLS_SHLIB and USE_LDCONFIG
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-ports-bugs
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Feb 04 01:50:21 GMT 2007
>Closed-Date:
>Last-Modified:
>Originator:     Gerald Pfeifer
>Release:        FreeBSD 7.0-CURRENT amd64
>Organization:
FreeBSD.org
>Environment:
>Description:
	Today I was debugging some aspects of Mk/bsd.port.mk and found that
	for some parts the documentation was not sufficient for me to under-
	stand things well enough and that I had to "reverse engineers" some
	aspects.

	This patch tries to help address this.  Specifically, it updates
	and hopefully improves the descriptions of INSTALLS_SHLIB and
	USE_LDCONFIG.

	I'm sure it's not perfect, but I hope it can serve as a base for
	further changes. ;-)
>How-To-Repeat:
>Fix:


Index: bsd.port.mk
===================================================================
RCS file: /home/pcvs/ports/Mk/bsd.port.mk,v
retrieving revision 1.547
diff -u -r1.547 bsd.port.mk
--- bsd.port.mk	31 Jan 2007 14:07:24 -0000	1.547
+++ bsd.port.mk	4 Feb 2007 01:41:30 -0000
@@ -909,9 +909,9 @@
 #				- If set, bsd.port.mk will automatically run ldconfig commands
 #				  from post-install and also add appropriate @exec/@unexec
 #				  directives to directories listed in LDCONFIG_DIRS. (deprecated)
-#				  If USE_LINUX_PREFIX is defined, the Linux version of ldconfig
-#				  will be used instead of the native FreeBSD version (in such
-#				  case, LDCONFIG_DIRS is ignored).
+#				  If USE_LINUX_PREFIX is defined, the Linux version of
+#				  ldconfig will be used instead of the native FreeBSD
+#				  version and LDCONFIG_DIRS is ignored.
 # LDCONFIG_DIRS	- List of directories to run ldconfig if INSTALLS_SHLIB is set.
 #				  Note that this is passed through sed just like the
 #				  rest of PLIST, so ${PLIST_SUB} substitutions also
@@ -919,12 +919,15 @@
 #				  %%PREFIX%% for ${PREFIX}, %%LOCALBASE%% for
 #				  ${LOCALBASE_REL} and %%X11BASE%% for ${X11BASE_REL}.
 #				  Default: %%PREFIX%%/lib
-# USE_LDCONFIG  - If set to "yes", it replaces the old variable INSTALLS_SHLIB.
-# 				  Otherwise, it can be set to a list of directories to be added to
-# 				  ${PREFIX}/libdata/ldconfig/${UNIQUENAME}. Note that this
-# 				  directory is used by ldconfig startup script, it is meant to
-# 				  replace ldconfig scripts installed by some ports as (sometimes)
-# 				  000.${UNQUENAME}.sh.
+# USE_LDCONFIG  - If set to "yes", this assumes the function of the deprecated
+#				  variable INSTALLS_SHLIB and adds ${PREFIX}/lib to the list
+#				  of directories to be searched for shared libraries.
+#				  Otherwise, this is a list of directories to be added to that
+#				  list.  Technically, these directory names are written to a
+#				  file ${PREFIX}/libdata/ldconfig/${UNIQUENAME} which is then
+#				  used by the ldconfig startup script.
+#				  This mechanism replaces ldconfig scripts installed by some
+#				  ports (often under names such as 000.${UNQUENAME}.sh).
 # USE_LDCONFIG32
 # 				- Same as USE_LDCONFIG but the target file is
 # 				  ${PREFIX}/libdata/ldconfig32/${UNIQUENAME} instead.

>Release-Note:
>Audit-Trail:
>Unformatted: