me
/
guix
Archived
1
0
Fork 0
Code

doc: Clarify what propagated inputs are. 

Fixes <https://bugs.gnu.org/26170>.

* doc/guix.texi (package Reference)[package-propagated-inputs]: Clarify.
master
Florian Pelz 2020-09-16 15:18:08 +02:00
parent de4705d92d
commit 125fc37e5f
No known key found for this signature in database
GPG Key ID: 300888CB39C63817
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/guix.texi
View File

@ -59,7 +59,7 @@ Copyright @copyright{} 2018 Oleg Pykhalov@*
Copyright @copyright{} 2018 Mike Gerwitz@* Copyright @copyright{} 2018 Mike Gerwitz@*
Copyright @copyright{} 2018 Pierre-Antoine Rouby@* Copyright @copyright{} 2018 Pierre-Antoine Rouby@*
Copyright @copyright{} 2018, 2019 Gábor Boskovits@* Copyright @copyright{} 2018, 2019 Gábor Boskovits@*
Copyright @copyright{} 2018, 2019 Florian Pelz@* Copyright @copyright{} 2018, 2019, 2020 Florian Pelz@*
Copyright @copyright{} 2018 Laura Lazzati@* Copyright @copyright{} 2018 Laura Lazzati@*
Copyright @copyright{} 2018 Alex Vong@* Copyright @copyright{} 2018 Alex Vong@*
Copyright @copyright{} 2019 Josh Holland@* Copyright @copyright{} 2019 Josh Holland@*
@ -6370,21 +6370,22 @@ this area (@pxref{Invoking guix lint}).
@anchor{package-propagated-inputs} @anchor{package-propagated-inputs}
Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the Lastly, @code{propagated-inputs} is similar to @code{inputs}, but the
specified packages will be automatically installed alongside the package specified packages will be automatically installed to profiles
(@pxref{Features, the role of profiles in Guix}) alongside the package
they belong to (@pxref{package-cmd-propagated-inputs, @command{guix they belong to (@pxref{package-cmd-propagated-inputs, @command{guix
package}}, for information on how @command{guix package} deals with package}}, for information on how @command{guix package} deals with
propagated inputs). propagated inputs).
For example this is necessary when a C/C++ library needs headers of For example this is necessary when packaging a C/C++ library that needs
another library to compile, or when a pkg-config file refers to another headers of another library to compile, or when a pkg-config file refers
one @i{via} its @code{Requires} field. to another one @i{via} its @code{Requires} field.
Another example where @code{propagated-inputs} is useful is for languages Another example where @code{propagated-inputs} is useful is for languages
that lack a facility to record the run-time search path akin to the that lack a facility to record the run-time search path akin to the
@code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and @code{RUNPATH} of ELF files; this includes Guile, Python, Perl, and
more. To ensure that libraries written in those languages can find more. When packaging libraries written in those languages, ensure they
library code they depend on at run time, run-time dependencies must be can find library code they depend on at run time by listing run-time
listed in @code{propagated-inputs} rather than @code{inputs}. dependencies in @code{propagated-inputs} rather than @code{inputs}.
@item @code{outputs} (default: @code{'("out")}) @item @code{outputs} (default: @code{'("out")})
The list of output names of the package. @xref{Packages with Multiple The list of output names of the package. @xref{Packages with Multiple