changeset 13365:09288814c405

Update maintainer documentation for 'relocatable-prog' module.
author Ben Pfaff <blp@cs.stanford.edu>
date Sun, 23 May 2010 12:02:39 -0700
parents f07c1f071ff0
children 8c0d5f7896a2
files ChangeLog doc/relocatable-maint.texi
diffstat 2 files changed, 27 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2010-05-23  Ben Pfaff  <blp@cs.stanford.edu>
+
+	Update maintainer documentation for 'relocatable-prog' module.
+	* doc/relocatable-maint.texi: Update.
+	Comments by Bruno Haible.
+
 2010-05-23  Bruno Haible  <bruno@clisp.org>
 
 	git-merge-changelog: Enable --split-merged-entry by default.
--- a/doc/relocatable-maint.texi
+++ b/doc/relocatable-maint.texi
@@ -89,6 +89,27 @@
 The prototype for this function is in @file{relocatable.h}.
 
 @item
+The @code{set_program_name} function can also configure some
+additional libraries to relocate files that they access, by defining
+corresponding C preprocessor symbols to 1.  The libraries for which
+this is supported and the corresponding preprocessor symbols are:
+
+@table @asis
+@item libcharset
+@code{DEPENDS_ON_LIBCHARSET}
+
+@item libiconv
+@code{DEPENDS_ON_LIBICONV}
+
+@item libintl
+@code{DEPENDS_ON_LIBINTL}
+@end table
+
+Defining the symbol for a library makes every program in the package
+depend on that library, whether the program really uses the library or
+not, so this feature should be used with some caution.
+
+@item
 If your package installs shell scripts, also import the
 @code{relocatable-script} module.  Then, near the beginning of each
 shell script that your package installs, add the following: