Gentoo Archives: gentoo-dev

From: Ralph Sennhauser <sera@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 09:02:24
Message-Id: 20130106100405.3c2e516e@sera-20.lan
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, 4 Jan 2013 23:34:59 -0600
2 Donnie Berkholz <dberkholz@g.o> wrote:
3
4 > On 10:26 Sat 22 Dec , Pacho Ramos 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"
11 > > messages for informing people about configuration (like pointing
12 > > people to external links to get proper way of configuring things,
13 > > tell them to add to some system groups...). I thought that maybe
14 > > this kind of information could be simply included in a canonical
15 > > file under /usr/share/doc/ package dir called, for example,
16 > > CONFIGURATION or SETUP. We would them point people (now with a news
17 > > item, for the long term provably a note to handbook to newcomers
18 > > would be nice) to that file to configure their setups. The main
19 > > advantages I see:
20 > > - We will flood less summary.log ;)
21 > > - The information to configure the package is always present while
22 > > package is installed, now, if we remove merge produced logs, people
23 > > will need to reemerge the package or read directly the ebuild
24 > >
25 > > What do you think?
26 >
27 > Bikeshedding ... would go with README.gentoo, because people are
28 > already used to looking for README files. Every time we can eliminate
29 > Gentoo-specific weirdness, we should.
30 >
31
32 See the documentation for README.Debian[1], most importantly the
33 example. ;)
34
35 I'd say we should handle it the same as Debian does. What could we
36 possibly gain from doing it differently?
37
38 [1] http://www.debian.org/doc/manuals/maint-guide/dother.en.html#readme

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies