From mboxrd@z Thu Jan 1 00:00:00 1970 From: ludo@gnu.org (Ludovic =?utf-8?Q?Court=C3=A8s?=) Subject: Re: [PATCH] doc: Document native-inputs and propagated-inputs. Date: Fri, 15 May 2015 12:32:19 +0200 Message-ID: <87d2222kss.fsf@gnu.org> References: <87oalmhoxy.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:43901) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YtCuo-0001zX-6q for guix-devel@gnu.org; Fri, 15 May 2015 06:32:30 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1YtCuk-000536-4U for guix-devel@gnu.org; Fri, 15 May 2015 06:32:26 -0400 Received: from fencepost.gnu.org ([2001:4830:134:3::e]:56804) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1YtCuk-00052s-1G for guix-devel@gnu.org; Fri, 15 May 2015 06:32:22 -0400 In-Reply-To: <87oalmhoxy.fsf@gmail.com> (Taylan Ulrich Kammer's message of "Thu, 14 May 2015 22:41:29 +0200") List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org To: Taylan Ulrich Kammer Cc: guix-devel@gnu.org Taylan Ulrich Kammer skribis: > From 0f001497234df55e3c131c10f84ddf184261ee09 Mon Sep 17 00:00:00 2001 > From: =3D?UTF-8?q?Taylan=3D20Ulrich=3D20Bay=3DC4=3DB1rl=3DC4=3DB1/Kammer?= =3D > > Date: Thu, 14 May 2015 22:37:04 +0200 > Subject: [PATCH] doc: Document native-inputs and propagated-inputs. > > * doc/guix.texi (Defining Packages): Add `native-inputs' and > `propagated-inputs' fields to the example package recipe, and explain t= hem. [...] > --- a/doc/guix.texi > +++ b/doc/guix.texi > @@ -1716,6 +1716,8 @@ package looks like this: > (build-system gnu-build-system) > (arguments `(#:configure-flags '("--enable-silent-rules"))) > (inputs `(("gawk" ,gawk))) > + (native-inputs `(("pkg-config" ,pkg-config))) > + (propagated-inputs `(("libfoo" ,libfoo))) I would not add it here since it=E2=80=99s incorrect code. > +@item > +The @code{native inputs} field specifies inputs for which it should be > +ensured that the version present at build-time is for the architecture > +on which the build is running. This is necessary for cross-compilation > +when programs from the input will be executed at build-time. This field > +will frequently have build tools such as autotools components, libtool, > +pkg-config, or gettext. s/autotools components/Autoconf/ and capitalize =E2=80=9CLibtool=E2=80=9D a= nd =E2=80=9CGettext.=E2=80=9D > +@item > +The @code{propagated inputs} field specifies inputs whose installation > +should be forced alongside the installation of the package. For > +example, some shared libraries expect another shared library, on which > +they depend, to be linked alongside them. In that case said dependency > +should be installed alongside the library, so that when a program wants > +to use the library it can correctly link against both the library and > +its dependency. What about taking the example that is in =E2=80=9CInvoking guix package=E2= =80=9D, which explicitly mentions C header file dependencies? More importantly, I think we should have a =E2=80=9Cpackage Reference=E2=80= =9D section (akin to the existing =E2=80=9Coperating-system Reference=E2=80=9D section)= right after =E2=80=9CDefining Packages.=E2=80=9D That way, we could keep =E2=80=9CDefi= ning Packages=E2=80=9D simple and concise, and simply cross-ref to the reference section for details. That=E2=80=99s more work, but that=E2=80=99d be real cool. WDYT? :-) Thanks! Ludo=E2=80=99.