unofficial mirror of bug-guix@gnu.org 
 help / color / mirror / code / Atom feed
From: "Ludovic Courtès" <ludo@gnu.org>
To: "pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de>
Cc: 26170@debbugs.gnu.org
Subject: bug#26170: Bug #26170 Hunting: doc: Explanation of propagated-inputs unclear
Date: Wed, 16 Sep 2020 12:37:20 +0200	[thread overview]
Message-ID: <87een2nh27.fsf@gnu.org> (raw)
In-Reply-To: <20200909151021.dnte7uodi3gj5t6r@pelzflorian.localdomain> (pelzflorian@pelzflorian.de's message of "Wed, 9 Sep 2020 17:10:21 +0200")

Hi,

"pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> skribis:

> 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

Like zimoun wrote, please introduce a newline.

>  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}.

I’m not convinced about this hunk; it uses imperative tense towards the
reader to state the same thing no?

Otherwise LGTM, thanks!

Ludo’.




  parent reply	other threads:[~2020-09-16 10:38 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-03-19  7:03 bug#26170: documentation: Explanation of propagated-inputs unclear pelzflorian (Florian Pelz)
2019-12-03 12:14 ` bug#26170: Bug #26170 Hunting: doc: " zimoun
2019-12-03 12:49   ` pelzflorian (Florian Pelz)
2020-09-09 13:25     ` zimoun
2020-09-09 15:10       ` pelzflorian (Florian Pelz)
2020-09-09 15:45         ` zimoun
2020-09-16 10:37         ` Ludovic Courtès [this message]
2020-09-16 13:27           ` pelzflorian (Florian Pelz)
2020-09-17 19:45             ` Ludovic Courtès
2020-09-18  9:08               ` pelzflorian (Florian Pelz)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87een2nh27.fsf@gnu.org \
    --to=ludo@gnu.org \
    --cc=26170@debbugs.gnu.org \
    --cc=pelzflorian@pelzflorian.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).