Re: [gentoo-dev] About using a CONFIGURATION (or SETUP) file under /usr/share/doc for configuration information

[Brian Dolbec]

On Sat, 2012-12-22 at 10:26 +0100, Pacho Ramos wrote:
> Hello
>
> After seeing:
> https://bugs.gentoo.org/show_bug.cgi?id=440214
>
> Looking to a lot of its blockers shows that we are using "elog" messages
> for informing people about configuration (like pointing people to
> external links to get proper way of configuring things, tell them to add
> to some system groups...). I thought that maybe this kind of information
> could be simply included in a canonical file under /usr/share/doc/
> package dir called, for example, CONFIGURATION or SETUP. We would them
> point people (now with a news item, for the long term provably a note to
> handbook to newcomers would be nice) to that file to configure their
> setups. The main advantages I see:
> - We will flood less summary.log ;)
> - The information to configure the package is always present while
> package is installed, now, if we remove merge produced logs, people will
> need to reemerge the package or read directly the ebuild
>
> What do you think?

I think that sounds like a perfectly acceptable solution for many of
those.


For layman, I ended up moving those elog messages to a layman-updater
script (needed for something else) which was capable of knowing what
messages were relevant to display.  I run that layman-updater script in 
pkg_postinst().
-- 
Brian Dolbec <dolsen@g.o>