From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nils Gillmann Subject: Re: 2 ideas Date: Mon, 11 Jun 2018 07:40:03 +0000 Message-ID: <20180611074003.xoxx2sxvm4nswgur@abyayala> 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> <87vaap295w.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:48832) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fSHQP-0007oK-NB for guix-devel@gnu.org; Mon, 11 Jun 2018 03:39:38 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fSHQM-0007lA-Kd for guix-devel@gnu.org; Mon, 11 Jun 2018 03:39:37 -0400 Received: from static.195.114.201.195.clients.your-server.de ([195.201.114.195]:47564 helo=conspiracy.of.n0.is) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fSHQM-0007kS-8D for guix-devel@gnu.org; Mon, 11 Jun 2018 03:39:34 -0400 Content-Disposition: inline In-Reply-To: <87vaap295w.fsf@gmail.com> 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: Chris Marusich Cc: Guix-devel , Nils Gillmann Chris Marusich transcribed 2.2K bytes: > 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 > --show=foo". 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 still think $out/guix/doc/ would be a good idea (so the summary in $GUIX_PROFILE/guix/doc), but other than that it seems like a good idea. > > 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). Wouldn't this be a case for optional-inputs (list)? This is what I want to provide. The output of it should tell you for which feature you need which independent runtime dependency. It's an entirely new subject, but you seem to be getting in that direction, right? Not everyone is aware of info, and we can not write and adjust man pages for every application. With our continued diverging from Unix traditions, self-documented package modules seem like the right choice - for both users as well as developers and "middle-ware users". > > -- > Chris