Gentoo Archives: gentoo-dev

From: Michael Mol <mikemol@×××××.com>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] About using a CONFIGURATION (or SETUP) file under /usr/share/doc for configuration information
Date: Mon, 07 Jan 2013 01:36:42
Message-Id: CA+czFiDcOm5q1ttU05pbPuxzX2wDLYtQWtrcq39SZn+MpcT-5g@mail.gmail.com
In Reply to: Re: [gentoo-dev] About using a CONFIGURATION (or SETUP) file under /usr/share/doc for configuration information by Zac Medico
1 On Jan 6, 2013 8:32 PM, "Zac Medico" <zmedico@g.o> wrote:
2 >
3 > On 01/06/2013 01:04 AM, Ralph Sennhauser wrote:
4 > > On Fri, 4 Jan 2013 23:34:59 -0600
5 > > Donnie Berkholz <dberkholz@g.o> wrote:
6 > >
7 > >> On 10:26 Sat 22 Dec , Pacho Ramos wrote:
8 > >>> Hello
9 > >>>
10 > >>> After seeing:
11 > >>> https://bugs.gentoo.org/show_bug.cgi?id=440214
12 > >>>
13 > >>> Looking to a lot of its blockers shows that we are using "elog"
14 > >>> messages for informing people about configuration (like pointing
15 > >>> people to external links to get proper way of configuring things,
16 > >>> tell them to add to some system groups...). I thought that maybe
17 > >>> this kind of information could be simply included in a canonical
18 > >>> file under /usr/share/doc/ package dir called, for example,
19 > >>> CONFIGURATION or SETUP. We would them point people (now with a news
20 > >>> item, for the long term provably a note to handbook to newcomers
21 > >>> would be nice) to that file to configure their setups. The main
22 > >>> advantages I see:
23 > >>> - We will flood less summary.log ;)
24 > >>> - The information to configure the package is always present while
25 > >>> package is installed, now, if we remove merge produced logs, people
26 > >>> will need to reemerge the package or read directly the ebuild
27 > >>>
28 > >>> What do you think?
29 > >>
30 > >> Bikeshedding ... would go with README.gentoo, because people are
31 > >> already used to looking for README files. Every time we can eliminate
32 > >> Gentoo-specific weirdness, we should.
33 > >>
34 > >
35 > > See the documentation for README.Debian[1], most importantly the
36 > > example. ;)
37 > >
38 > > I'd say we should handle it the same as Debian does.
39 >
40 > README.gentoo sounds good to me.
41 >
42 > > What could we possibly gain from doing it differently?
43 >
44 > Does Debian have a postinst message, like the proposed eclass would
45 > generate? Do you agree that a postinst message is desirable feature?
46 >
47 > > [1] http://www.debian.org/doc/manuals/maint-guide/dother.en.html#readme
48 > >
49 > --
50 > Thanks,
51 > Zac
52 >
53
54 If we had README.gentoo, I'd love it if Portage alerted me as those files
55 changed.

Replies