commit: 6b30f180594d6b6507aefc32505571bb420c579a Author: Michael Orlitzky <mjo <AT> gentoo <DOT> org> AuthorDate: Thu Jun 2 14:47:19 2016 +0000 Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org> CommitDate: Mon Oct 31 01:09:24 2016 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6b30f180
eclass-writing: add documentation to the incorrect usage example. Now that we have guidelines for documenting eclasses, the "Handling incorrect usage of an eclass" section is under-documented. This commit adds the minimum required documentation (eclass header) to that example. Gentoo-Bug: 373145 eclass-writing/text.xml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 518cf2a..def2b89 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -382,7 +382,10 @@ for an eclass to invoke die from the global scope. For example: # Distributed under the terms of the GNU General Public License v2 # $Id$ -# Purpose: Demonstration of die upon invalid EAPI usage. +# @ECLASS: eapi-die.eclass +# @MAINTAINER: +# Gentoo Devmanual Project <[email protected]> +# @BLURB: Calls die when used with an invalid EAPI. case ${EAPI:-0} in 0) die "this eclass doesn't support EAPI 0" ;;
