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

[Pacho Ramos]

El lun, 31-12-2012 a las 14:53 -0800, Zac Medico escribió:
> On 12/31/2012 05:21 AM, Pacho Ramos wrote:
> >  pkg_postinst() {
> >
> > Some improvements I am not sure how to implement just now:
> > - What would be the proper way to "elog" contents
> > of /usr/share/doc/${PF}/CONFIGURATION.bz2 and, then, allow the following
> > to be shorter:
> >
> > 	if ! has_version 'sys-power/acpid'; then
> > 		elog
> > 		elog "You may wish to read the Gentoo Linux Power Management Guide,"
> > 		elog "which can be found online at:"
> > 		elog "http://www.gentoo.org/doc/en/power-management-guide.xml"
> > 		elog
> > 	fi
> > ?
> >
> > Thanks for your help
> >
>
> It seems that you're allowed to call the unpack() function in any phase,
> so something like this should work:
>
>   cd "${T}"
>   cp "${EROOT}/usr/share/doc/${PF}/CONFIGURATION"* ./
>   [ -f ./CONFIGURATION ] || unpack ./CONFIGURATION*
>   elog "$(< ./CONFIGURATION)"
>
>

Thanks a lot for the tip :)

On the other hand, I have seen another way of doing that looking at
kernel-2.eclass:
--- /home/pacho/gentoo-x86/sys-power/acpid/acpid-2.0.17.ebuild
2012-11-26 09:20:15.000000000 +0100
+++ ./acpid-2.0.17.ebuild	2013-01-01 14:30:18.000000000 +0100
@@ -17,6 +17,11 @@
 RDEPEND="selinux? ( sec-policy/selinux-apm )"
 DEPEND="${RDEPEND}"
 
+CONFIGURATION_INSTRUCTIONS="
+	You may wish to read the Gentoo Linux Power Management Guide,
+	which can be found online at:
+	http://www.gentoo.org/doc/en/power-management-guide.xml"
+
 src_configure() {
 	econf --docdir=/usr/share/doc/${PF}
 }
@@ -37,6 +42,9 @@
 	newconfd "${FILESDIR}"/${PN}-2.0.16-conf.d ${PN}
 
 	systemd_dounit "${FILESDIR}"/systemd/${PN}.{service,socket}
+
+	echo ${CONFIGURATION_INSTRUCTIONS} | fmt > CONFIGURATION
+	dodoc CONFIGURATION
 }
 
 pkg_postinst() {
@@ -48,6 +56,8 @@
 		elog
 	fi
 
+	echo ${CONFIGURATION_INSTRUCTIONS} | fmt | while read -s ELINE; do
elog "${ELINE}"; done
+
 	# files/systemd/acpid.socket -> ListenStream=/run/acpid.socket
 	mkdir -p "${ROOT}"/run

This could probably be moved to eutils.eclass to use it on this kind of
ebuilds