| 1 |
commit: 9b2cbaa0aa82b432293cf32f904197f4d7759e7e |
| 2 |
Author: Michael Orlitzky <mjo <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Thu Jun 2 14:42:34 2016 +0000 |
| 4 |
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Mon Oct 31 01:09:18 2016 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9b2cbaa0 |
| 7 |
|
| 8 |
eclass-writing: add documentation to the first existing example. |
| 9 |
|
| 10 |
Now that we have guidelines for documenting eclasses, the "Simple |
| 11 |
Common Functions Eclass Example" section is under-documented. This |
| 12 |
commit adds the minimum required documentation (eclass and function |
| 13 |
headers) to that example. |
| 14 |
|
| 15 |
Gentoo-Bug: 373145 |
| 16 |
|
| 17 |
eclass-writing/text.xml | 21 +++++++++++---------- |
| 18 |
1 file changed, 11 insertions(+), 10 deletions(-) |
| 19 |
|
| 20 |
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml |
| 21 |
index 488230d..518cf2a 100644 |
| 22 |
--- a/eclass-writing/text.xml |
| 23 |
+++ b/eclass-writing/text.xml |
| 24 |
@@ -251,18 +251,19 @@ a single function, <c>domacosapp</c>. |
| 25 |
# Distributed under the terms of the GNU General Public License v2 |
| 26 |
# $Id$ |
| 27 |
|
| 28 |
-# |
| 29 |
-# Original Author: Ciaran McCreesh <ciaranm@g.o> |
| 30 |
-# Purpose: install macos .app files to the relevant location. |
| 31 |
-# |
| 32 |
-# Bugs to osx@g.o |
| 33 |
-# |
| 34 |
- |
| 35 |
-# domacosapp: install a macos .app file. Usage is 'domacosapp file' or |
| 36 |
-# 'domacosapp file newfile'. |
| 37 |
+# @ECLASS: macosapp.eclass |
| 38 |
+# @MAINTAINER: |
| 39 |
+# Ciaran McCreesh <ciaranm@g.o> |
| 40 |
+# @BLURB: install macos .app files to the relevant location. |
| 41 |
|
| 42 |
+# @FUNCTION: domacosapp |
| 43 |
+# @USAGE: <app-file> [new-file] |
| 44 |
+# @DESCRIPTION: |
| 45 |
+# Install the given .app file into the appropriate location. If |
| 46 |
+# [new-file] is given, it will be used as the new (installed) name of |
| 47 |
+# the file. Otherwise <app-file> is installed as-is. |
| 48 |
domacosapp() { |
| 49 |
- [[ -z "${1}" ]] && die "usage: domacosapp <file> <new file>" |
| 50 |
+ [[ -z "${1}" ]] && die "usage: domacosapp <file> [new file]" |
| 51 |
if use ppc-macos ; then |
| 52 |
insinto /Applications |
| 53 |
newins "$1" "${2:-${1}}" || die "Failed to install ${1}" |
Archives