bug#26170: Bug #26170 Hunting: doc: Explanation of propagated-inputs unclear

[zimoun]

On Wed, 09 Sep 2020 at 17:10, "pelzflorian (Florian Pelz)" 
<pelzflorian@pelzflorian.de> wrote:
> Thank you for bringing up this bug again with detailed
> cross-referencing.  Sorry for not sending a patch earlier.

My pleasure. :-)


>>From fd4955cd0a61e92c37a371e4c5411a505ad5ac76 Mon Sep 17 00:00:00 2001
> From: Florian Pelz <pelzflorian@pelzflorian.de>
> Date: Wed, 9 Sep 2020 16:54:04 +0200
> Content-Type: text/plain; charset=UTF-8
> Content-Transfer-Encoding: 8bit
> Subject: [PATCH] doc: Clarify what propagated inputs are.
>
> Fixes <https://issues.guix.info/issue/26170>.
>
> * doc/guix.texi (package Reference)[package-propagated-inputs]: Clarify.
> ---
>  doc/guix.texi | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 1d6782e6fa..0a5640b174 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -6360,21 +6360,21 @@ this area (@pxref{Invoking guix lint}).
>  
>  @anchor{package-propagated-inputs}
>  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

Do not forget the correct filling length. :-)

>  they 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 C/C++ library needs headers of
> +For example this is necessary when packaging a C/C++ library that needs 
> headers of

Idem.

>  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 the
>  @code{RUNPATH} of ELF files; this includes Guile, Python, Perl, 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}.
> +more.  When packaging libraries written in those languages, ensure they can 
> find
> +library code they depend on at run time by listing run-time dependencies
> +in @code{propagated-inputs} rather than @code{inputs}.

Idem.
And my English is not good enough to read the difference. :-)
  
>  @item @code{outputs} (default: @code{'("out")})
>  The list of output names of the package.  @xref{Packages with Multiple


All the best,
simon