diff options
| author |   Michael Orlitzky <mjo@gentoo.org> | 2016-06-02 10:47:19 -0400 |
|---|---|---|
| committer |   Göktürk Yüksek <gokturk@gentoo.org> | 2016-10-30 21:09:24 -0400 |
| commit | 6b30f180594d6b6507aefc32505571bb420c579a (patch) | |
| tree | c4be6f3aed4694f6f5f5e036129f1c8ce1023891 /eclass-writing | |
| parent | eclass-writing: add documentation to the first existing example. (diff) | |
| download | devmanual-6b30f180594d6b6507aefc32505571bb420c579a.tar.gz devmanual-6b30f180594d6b6507aefc32505571bb420c579a.tar.bz2 devmanual-6b30f180594d6b6507aefc32505571bb420c579a.zip | |
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
Diffstat (limited to 'eclass-writing')
| -rw-r--r-- | eclass-writing/text.xml | 5 |
1 files changed, 4 insertions, 1 deletions
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" ;; |