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