From mboxrd@z Thu Jan 1 00:00:00 1970 From: Chris Marusich Subject: Re: 2 ideas Date: Sun, 10 Jun 2018 22:18:19 -0700 Message-ID: <87vaap295w.fsf@gmail.com> References: <20180518184910.9987-21-ambrevar@gmail.com> <20180601075112.28494-1-ambrevar@gmail.com> <87vaatjptt.fsf@gnu.org> <8C242137-C737-4814-9367-6C90F5E96CD2@riseup.net> <20180609111751.rvm54ouwwr4wz7lo@abyayala> <87o9gizxgb.fsf@elephly.net> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:59690) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fSFDr-0003z4-1C for guix-devel@gnu.org; Mon, 11 Jun 2018 01:18:32 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fSFDn-0003L8-Rz for guix-devel@gnu.org; Mon, 11 Jun 2018 01:18:31 -0400 Received: from mail-pf0-x22d.google.com ([2607:f8b0:400e:c00::22d]:35109) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fSFDn-0003Ku-Lg for guix-devel@gnu.org; Mon, 11 Jun 2018 01:18:27 -0400 Received: by mail-pf0-x22d.google.com with SMTP id c22-v6so9180814pfi.2 for ; Sun, 10 Jun 2018 22:18:27 -0700 (PDT) In-Reply-To: <87o9gizxgb.fsf@elephly.net> (Ricardo Wurmus's message of "Sun, 10 Jun 2018 13:35:00 +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" To: Ricardo Wurmus Cc: Guix-devel , Nils Gillmann --=-=-= Content-Type: text/plain Content-Transfer-Encoding: quoted-printable Ricardo Wurmus writes: > It could be useful to have application-specific setup notes in a > well-known location that is gathered when the profile is built. Maybe we could begin by adding a simple, optional field ("post-install-notes", maybe?) to the record type? We could maybe print the notes in the output of invocations like "guix package =2D-show=3Dfoo". We could also add a profile hook to generate a simple summary of such documentation for a given profile, in a specific location (not sure where - depends on the format, maybe, but somewhere in $GUIX_PROFILE/share?). > I would not like these notes to be printed automatically upon > installation, but generating a file with important notes seems like a > good idea in general. I also think it's a good idea. It seems potentially more useful than maintaining separate documentation in the manual or in a wiki, too (although that is certainly useful, as well). There is something to be said for "self-documenting" package definitions. It would have helped me to learn, for example, that to play additional media types in Rhythmbox (from the rhythmbox package), I needed to install additional GStreamer plugins (from the gst-libav package, I think). =2D-=20 Chris --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEy/WXVcvn5+/vGD+x3UCaFdgiRp0FAlseBhsACgkQ3UCaFdgi Rp1IDRAAo+0WBGSTFT7L96cwnpcLQzmIJlwBt0BFIoPOwRkt+ZVxdBPgAXseAKS3 oDbvtISYjtKr2b7V2WRSImvqw10rzmAuYHW6Nzurv1WgF7YXmwqmOklPW/zlhOAA G+vi39YfEUTBuBQgQsTYXIxBDQpNMkvgMWqvq7f24f0dw3Nr4al0DBE42pddtR4n pE2RCBwgwxryLCg+U0LA20K5TnEFHNRoyxuXfxs5rii6Im1Zno1B7VFXUKndGaUC Lx14ib6SMoxmPGsPpTXBsijPpn3PRamoLa4RU1tY45N62NRfsHt3pjXjw0PLDqkQ f9qU2/VYwq25AGwkrEpq3BnTk0zYTuWsaXQsXIOYL2yqLbfHA1ndTht1Q5DyC26g gHQka8jdG0JVBBwVRR80zhecfP8rtAKRSzP72wFRm932KY7X6ioo6lto8xt142xI WZzyIQpxcocwI89OsqF47TIX52RW76EknxatILQhbPL6XzcqcWQOo2Rs4f6fj5Je ClzZLWJnKj3swLWznWPX+bEZ5H/BKZz01x0zPfjpam4idNTs4nsas5JkZiRNcITe 6mQzspfSPjn+zIi1O58lD8NXgRc/c77nvii1cmFaXEGdDjQjCsp2ZDJRtPE6pDKr T70uvSxoUZF7sVOtFx2ht2K8b5VE1pyFsfzd0ka4OP2z5M5BPYM= =ppfl -----END PGP SIGNATURE----- --=-=-=--