summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2015-12-15 12:00:39 +0100
committerLudovic Courtès <ludo@gnu.org>2015-12-15 13:43:27 +0100
commite0508b6bf7a378e774b42e212befc77d5fb3eb5e (patch)
treef42f32e38fbb1c6b9e311cb77115acc45fed7a25 /doc
parent75f52fca95536b543a39dbee775c16aff0a67ef0 (diff)
downloadguix-e0508b6bf7a378e774b42e212befc77d5fb3eb5e.tar.gz
doc: Give another example use of 'propagated-inputs'.
Suggested by Leo Famulari <leo@famulari.name>.

* doc/guix.texi (package Reference): Explain 'propagated-inputs' for
non-C languages.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index 07668e917f..f63e3669fa 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -2305,9 +2305,16 @@ belong to (@pxref{package-cmd-propagated-inputs, @command{guix
 package}}, for information on how @command{guix package} deals with
 propagated inputs.)
 
-For example this is necessary when a library needs headers of another
-library to compile, or needs another shared library to be linked
-alongside itself when a program wants to link to it.
+For example this is necessary when a C/C++ library needs headers of
+another library to compile, or when a pkg-config file refers to another
+one @i{via} its @code{Requires} field.
+
+Another example where @code{propagated-inputs} is useful is for
+languages that lack a facility to record the run-time search path akin
+to ELF's @code{RUNPATH}; this includes Guile, Python, Perl, GHC, and
+more.  To ensure that libraries written in those languages can find
+library code they depend on at run time, run-time dependencies must be
+listed in @code{propagated-inputs} rather than @code{inputs}.
 
 @item @code{self-native-input?} (default: @code{#f})
 This is a Boolean field telling whether the package should use itself as