blob: cedd0580a3d6260ab849a3297b2254f85ca77f05 [file] [log] [blame]
# Copyright 1999-2018 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: readme.gentoo.eclass
# Pacho Ramos <>
# Author: Pacho Ramos <>
# @BLURB: install a doc file shown via elog messages
# An eclass for installing a README.gentoo doc file recording tips
# shown via elog messages. With this eclass, those elog messages will only be
# shown at first package installation and a file for later reviewing will be
# installed under /usr/share/doc/${PF}
# This eclass is DEPRECATED. Please use readme.gentoo-r1 instead.
if [[ -z ${_README_GENTOO_ECLASS} ]]; then
inherit eutils
case "${EAPI:-0}" in
die "Unsupported EAPI=${EAPI:-0} (too old) for ${ECLASS}"
# EAPI>=4 is required for REPLACING_VERSIONS preventing us
# from needing to export another pkg_preinst phase to save has_version
# result. Also relies on EAPI >=4 default src_install phase.
EXPORT_FUNCTIONS src_install pkg_postinst
die "Unsupported EAPI=${EAPI} for ${ECLASS}"
die "Please migrate to readme.gentoo-r1.eclass and note that"
die "it stops to export any ebuild phases and, then, you will"
die "need to ensure readme.gentoo_create_doc is called in"
die "src_install and readme.gentoo_print_elog in pkg_postinst"
die "Unsupported EAPI=${EAPI} (unknown) for ${ECLASS}"
# If non-empty, DOC_CONTENTS information will be strictly respected,
# not getting it automatically formatted by fmt. If empty, it will
# rely on fmt for formatting and 'echo -e' options to tweak lines a bit.
# If non-empty this variable forces elog messages to be printed.
# If you want to specify a suffix for README.gentoo file please export it.
# @FUNCTION: readme.gentoo_create_doc
# Create doc file with ${DOC_CONTENTS} variable (preferred) and, if not set,
# look for "${FILESDIR}/README.gentoo" contents. You can use
# ${FILESDIR}/README.gentoo-${SLOT} also.
# Usually called at src_install phase.
readme.gentoo_create_doc() {
debug-print-function ${FUNCNAME} "${@}"
if [[ -n "${DOC_CONTENTS}" ]]; then
set -f
if [[ -n "${DISABLE_AUTOFORMATTING}" ]]; then
echo "${DOC_CONTENTS}" > "${T}"/README.gentoo
echo -e ${DOC_CONTENTS} | fold -s -w 70 \
| sed 's/[[:space:]]*$//' > "${T}"/README.gentoo
elif [[ -f "${FILESDIR}/README.gentoo-${SLOT%/*}" ]]; then
cp "${FILESDIR}/README.gentoo-${SLOT%/*}" "${T}"/README.gentoo || die
elif [[ -f "${FILESDIR}/README.gentoo${README_GENTOO_SUFFIX}" ]]; then
cp "${FILESDIR}/README.gentoo${README_GENTOO_SUFFIX}" "${T}"/README.gentoo || die
die "You are not specifying README.gentoo contents!"
dodoc "${T}"/README.gentoo
# @FUNCTION: readme.gentoo_print_elog
# Print elog messages with "${T}"/README.gentoo contents. They will be
# shown only when package is installed at first time.
# Usually called at pkg_postinst phase.
# If you want to show them always, please set FORCE_PRINT_ELOG to a non empty
# value in your ebuild before this function is called.
# This can be useful when, for example, DOC_CONTENTS is modified, then, you can
# rely on specific REPLACING_VERSIONS handling in your ebuild to print messages
# when people update from versions still providing old message.
readme.gentoo_print_elog() {
debug-print-function ${FUNCNAME} "${@}"
eqawarn "${CATEGORY}/${PN} is using the deprecated readme.gentoo.eclass."
eqawarn "Please use readme.gentoo-r1 instead."
if [[ -z "${README_GENTOO_DOC_VALUE}" ]]; then
die "readme.gentoo_print_elog invoked without matching readme.gentoo_create_doc call!"
elif ! [[ -n "${REPLACING_VERSIONS}" ]] || [[ -n "${FORCE_PRINT_ELOG}" ]]; then
echo -e "${README_GENTOO_DOC_VALUE}" | while read -r ELINE; do elog "${ELINE}"; done
elog ""
elog "(Note: Above message is only printed the first time package is"
elog "installed. Please look at ${EPREFIX}/usr/share/doc/${PF}/README.gentoo*"
elog "for future reference)"
# @FUNCTION: readme.gentoo_src_install
# Install generated doc file automatically.
readme.gentoo_src_install() {
debug-print-function ${FUNCNAME} "${@}"
# @FUNCTION: readme.gentoo_pkg_postinst
# Show elog messages from from just generated doc file.
readme.gentoo_pkg_postinst() {
debug-print-function ${FUNCNAME} "${@}"