Gentoo Archives: gentoo-dev

From: William Hubbs <williamh@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, 06 Jan 2013 04:25:09
Message-Id: 20130106042414.GA10125@linux1
In Reply to: Re: [gentoo-dev] About using a CONFIGURATION (or SETUP) file under /usr/share/doc for configuration information by Donnie Berkholz
1 On Fri, Jan 04, 2013 at 11:34:59PM -0600, Donnie Berkholz wrote:
2 > On 10:26 Sat 22 Dec , Pacho Ramos wrote:
3 > > Hello
4 > >
5 > > After seeing:
6 > > https://bugs.gentoo.org/show_bug.cgi?id=440214
7 > >
8 > > Looking to a lot of its blockers shows that we are using "elog" messages
9 > > for informing people about configuration (like pointing people to
10 > > external links to get proper way of configuring things, tell them to add
11 > > to some system groups...). I thought that maybe this kind of information
12 > > could be simply included in a canonical file under /usr/share/doc/
13 > > package dir called, for example, CONFIGURATION or SETUP. We would them
14 > > point people (now with a news item, for the long term provably a note to
15 > > handbook to newcomers would be nice) to that file to configure their
16 > > setups. The main advantages I see:
17 > > - We will flood less summary.log ;)
18 > > - The information to configure the package is always present while
19 > > package is installed, now, if we remove merge produced logs, people will
20 > > need to reemerge the package or read directly the ebuild
21 > >
22 > > What do you think?
23 >
24 > Bikeshedding ... would go with README.gentoo, because people are already
25 > used to looking for README files. Every time we can eliminate
26 > Gentoo-specific weirdness, we should.
27
28 Thinking about this, I tend to agree. That way we can put the README
29 file in ${FILESDIR} and change it whenever we need to for different
30 versions of the package.
31
32 William
33
34 >
35 > --
36 > Thanks,
37 > Donnie
38 >
39 > Donnie Berkholz
40 > Council Member / Sr. Developer, Gentoo Linux <http://dberkholz.com>
41 > Analyst, RedMonk <http://redmonk.com/dberkholz/>