summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin H. Johnson <robbat2@gentoo.org>2015-08-08 13:49:04 -0700
committerRobin H. Johnson <robbat2@gentoo.org>2015-08-08 17:38:18 -0700
commit56bd759df1d0c750a065b8c845e93d5dfa6b549d (patch)
tree3f91093cdb475e565ae857f1c5a7fd339e2d781e /eclass/readme.gentoo.eclass
downloadgentoo-56bd759df1d0c750a065b8c845e93d5dfa6b549d.tar.gz
gentoo-56bd759df1d0c750a065b8c845e93d5dfa6b549d.tar.bz2
gentoo-56bd759df1d0c750a065b8c845e93d5dfa6b549d.zip
proj/gentoo: Initial commit
This commit represents a new era for Gentoo: Storing the gentoo-x86 tree in Git, as converted from CVS. This commit is the start of the NEW history. Any historical data is intended to be grafted onto this point. Creation process: 1. Take final CVS checkout snapshot 2. Remove ALL ChangeLog* files 3. Transform all Manifests to thin 4. Remove empty Manifests 5. Convert all stale $Header$/$Id$ CVS keywords to non-expanded Git $Id$ 5.1. Do not touch files with -kb/-ko keyword flags. Signed-off-by: Robin H. Johnson <robbat2@gentoo.org> X-Thanks: Alec Warner <antarus@gentoo.org> - did the GSoC 2006 migration tests X-Thanks: Robin H. Johnson <robbat2@gentoo.org> - infra guy, herding this project X-Thanks: Nguyen Thai Ngoc Duy <pclouds@gentoo.org> - Former Gentoo developer, wrote Git features for the migration X-Thanks: Brian Harring <ferringb@gentoo.org> - wrote much python to improve cvs2svn X-Thanks: Rich Freeman <rich0@gentoo.org> - validation scripts X-Thanks: Patrick Lauer <patrick@gentoo.org> - Gentoo dev, running new 2014 work in migration X-Thanks: Michał Górny <mgorny@gentoo.org> - scripts, QA, nagging X-Thanks: All of other Gentoo developers - many ideas and lots of paint on the bikeshed
Diffstat (limited to 'eclass/readme.gentoo.eclass')
-rw-r--r--eclass/readme.gentoo.eclass130
1 files changed, 130 insertions, 0 deletions
diff --git a/eclass/readme.gentoo.eclass b/eclass/readme.gentoo.eclass
new file mode 100644
index 00000000000..4947bb55c2a
--- /dev/null
+++ b/eclass/readme.gentoo.eclass
@@ -0,0 +1,130 @@
+# Copyright 1999-2014 Gentoo Foundation
+# Distributed under the terms of the GNU General Public License v2
+# $Id$
+
+# @ECLASS: readme.gentoo
+# @MAINTAINER:
+# Pacho Ramos <pacho@gentoo.org>
+# @AUTHOR:
+# Author: Pacho Ramos <pacho@gentoo.org>
+# @BLURB: An eclass for installing a README.gentoo doc file recording tips
+# shown via elog messages.
+# @DESCRIPTION:
+# 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}
+
+if [[ -z ${_README_GENTOO_ECLASS} ]]; then
+_README_GENTOO_ECLASS=1
+
+inherit eutils
+
+case "${EAPI:-0}" in
+ 0|1|2|3)
+ die "Unsupported EAPI=${EAPI:-0} (too old) for ${ECLASS}"
+ ;;
+ 4|5)
+ # 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.
+ ;;
+ *)
+ die "Unsupported EAPI=${EAPI} (unknown) for ${ECLASS}"
+ ;;
+esac
+
+EXPORT_FUNCTIONS src_install pkg_postinst
+
+# @ECLASS-VARIABLE: DISABLE_AUTOFORMATTING
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# 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.
+
+# @ECLASS-VARIABLE: FORCE_PRINT_ELOG
+# @DEFAULT_UNSET
+# @DESCRIPTION:
+# If non-empty this variable forces elog messages to be printed.
+
+# @ECLASS-VARIABLE: README_GENTOO_SUFFIX
+# @DESCRIPTION:
+# If you want to specify a suffix for README.gentoo file please export it.
+: ${README_GENTOO_SUFFIX:=""}
+
+# @FUNCTION: readme.gentoo_create_doc
+# @DESCRIPTION:
+# 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
+ eshopts_push
+ set -f
+ if [[ -n "${DISABLE_AUTOFORMATTING}" ]]; then
+ echo "${DOC_CONTENTS}" > "${T}"/README.gentoo
+ else
+ echo -e ${DOC_CONTENTS} | fold -s -w 70 \
+ | sed 's/[[:space:]]*$//' > "${T}"/README.gentoo
+ fi
+ eshopts_pop
+ 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
+ else
+ die "You are not specifying README.gentoo contents!"
+ fi
+
+ dodoc "${T}"/README.gentoo
+ README_GENTOO_DOC_VALUE=$(< "${T}/README.gentoo")
+}
+
+# @FUNCTION: readme.gentoo_print_elog
+# @DESCRIPTION:
+# 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} "${@}"
+
+ 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)"
+ fi
+}
+
+
+# @FUNCTION: readme.gentoo_src_install
+# @DESCRIPTION:
+# Install generated doc file automatically.
+readme.gentoo_src_install() {
+ debug-print-function ${FUNCNAME} "${@}"
+ default
+ readme.gentoo_create_doc
+}
+
+# @FUNCTION: readme.gentoo_pkg_postinst
+# @DESCRIPTION:
+# Show elog messages from from just generated doc file.
+readme.gentoo_pkg_postinst() {
+ debug-print-function ${FUNCNAME} "${@}"
+ readme.gentoo_print_elog
+}
+
+fi