Gentoo Archives: gentoo-dev

From: Markos Chandras <hwoarang@g.o>
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: Sun, 23 Dec 2012 12:21:56
Message-Id: CAG2jQ8jKpwEtCi_s3PwXLtU9BvMjLyUrbfW1NAdp-y8VzmQidw@mail.gmail.com
In Reply to: Re: [gentoo-dev] About using a CONFIGURATION (or SETUP) file under /usr/share/doc for configuration information by Pacho Ramos
1 On 23 December 2012 09:57, Pacho Ramos <pacho@g.o> wrote:
2 > El sáb, 22-12-2012 a las 13:53 -0800, Zac Medico escribió:
3 >> On 12/22/2012 01:46 PM, Markos Chandras wrote:
4 >> > On 22 December 2012 09:26, Pacho Ramos <pacho@g.o> wrote:
5 >> >> Hello
6 >> >>
7 >> >> After seeing:
8 >> >> https://bugs.gentoo.org/show_bug.cgi?id=440214
9 >> >>
10 >> >> Looking to a lot of its blockers shows that we are using "elog" messages
11 >> >> for informing people about configuration (like pointing people to
12 >> >> external links to get proper way of configuring things, tell them to add
13 >> >> to some system groups...). I thought that maybe this kind of information
14 >> >> could be simply included in a canonical file under /usr/share/doc/
15 >> >> package dir called, for example, CONFIGURATION or SETUP. We would them
16 >> >> point people (now with a news item, for the long term provably a note to
17 >> >> handbook to newcomers would be nice) to that file to configure their
18 >> >> setups. The main advantages I see:
19 >> >> - We will flood less summary.log ;)
20 >> >> - The information to configure the package is always present while
21 >> >> package is installed, now, if we remove merge produced logs, people will
22 >> >> need to reemerge the package or read directly the ebuild
23 >> >>
24 >> >> What do you think?
25 >> >
26 >> > Correct me if I am wrong but are you suggesting we drop the elog
27 >> > messages altogether? I still believe that having the elog messages
28 >> > at the end of an 'emerge -uDN world' is more convenient. Maybe it
29 >> > makes sense to have both, as in print the elog messages and
30 >> > create those CONFIGURATION or SETUP files at the same time.
31 >>
32 >> As a compromise, you could have the ebuild trigger the elog message only
33 >> when there is not a previous version of the package installed.
34 >
35 > That sounds interesting in combination :O Looking to, for example, e4rat
36 > ebuild, it should elog the info to configure it first time and later
37 > people could rely on CONFIGURATION doc to recover that information, not
38 > flooding summary.log any longer and not losing the info, looks nice :D
39
40 But like I said, elog messages are already saved in
41 /var/log/portage/elog/$cat/$pf so people can
42 read these. Isn't this the same with what you suggest?
43
44 --
45 Regards,
46 Markos Chandras / Gentoo Linux Developer / Key ID: B4AFF2C2

Replies