From 53d3ea153e26b1f08900590db36b8b814430d922 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 2 Jun 2016 10:47:19 -0400 Subject: [PATCH 3/4] 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 <devmanual@gentoo.org> +# @BLURB: Calls die when used with an invalid EAPI. case ${EAPI:-0} in 0) die "this eclass doesn't support EAPI 0" ;; -- 2.7.3