From: Chris Marusich <cmmarusich@gmail.com>
To: Ricardo Wurmus <rekado@elephly.net>
Cc: Guix-devel <guix-devel@gnu.org>, Nils Gillmann <ng0@n0.is>
Subject: Re: 2 ideas
Date: Sun, 10 Jun 2018 22:18:19 -0700 [thread overview]
Message-ID: <87vaap295w.fsf@gmail.com> (raw)
In-Reply-To: <87o9gizxgb.fsf@elephly.net> (Ricardo Wurmus's message of "Sun, 10 Jun 2018 13:35:00 +0200")
[-- Attachment #1: Type: text/plain, Size: 1279 bytes --]
Ricardo Wurmus <rekado@elephly.net> 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 <package> 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 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).
--
Chris
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]
next prev parent reply other threads:[~2018-06-11 5:18 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20180518184910.9987-21-ambrevar@gmail.com>
[not found] ` <20180601075112.28494-1-ambrevar@gmail.com>
[not found] ` <87vaatjptt.fsf@gnu.org>
2018-06-09 9:12 ` 2 ideas (Was: Re: bug#31518: [PATCH 10/21] gnu: Add emacs-google-translate.) swedebugia
2018-06-09 11:17 ` Nils Gillmann
2018-06-10 7:19 ` 2 ideas Chris Marusich
2018-06-10 9:54 ` Pierre Neidhardt
2018-06-10 11:26 ` Thorsten Wilms
2018-06-10 11:45 ` Gábor Boskovits
2018-06-10 11:35 ` 2 ideas (Was: Re: bug#31518: [PATCH 10/21] gnu: Add emacs-google-translate.) Ricardo Wurmus
2018-06-10 13:42 ` swedebugia
2018-06-10 14:16 ` Nils Gillmann
2018-06-11 5:18 ` Chris Marusich [this message]
2018-06-11 7:40 ` 2 ideas Nils Gillmann
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=87vaap295w.fsf@gmail.com \
--to=cmmarusich@gmail.com \
--cc=guix-devel@gnu.org \
--cc=ng0@n0.is \
--cc=rekado@elephly.net \
/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).