diff options
| author |   Michael Orlitzky <mjo@gentoo.org> | 2016-06-02 10:42:34 -0400 |
|---|---|---|
| committer |   Göktürk Yüksek <gokturk@gentoo.org> | 2016-10-30 21:09:18 -0400 |
| commit | 9b2cbaa0aa82b432293cf32f904197f4d7759e7e (patch) | |
| tree | bf6419d3cb0a19ec987a4ac6f0651603e48ce4ee /eclass-writing/text.xml | |
| parent | eclass-writing: add "Documenting Eclasses" section and examples. (diff) | |
| download | devmanual-9b2cbaa0aa82b432293cf32f904197f4d7759e7e.tar.gz devmanual-9b2cbaa0aa82b432293cf32f904197f4d7759e7e.tar.bz2 devmanual-9b2cbaa0aa82b432293cf32f904197f4d7759e7e.zip | |
eclass-writing: add documentation to the first existing example.
Now that we have guidelines for documenting eclasses, the "Simple
Common Functions Eclass Example" section is under-documented. This
commit adds the minimum required documentation (eclass and function
headers) to that example.
Gentoo-Bug: 373145
Diffstat (limited to 'eclass-writing/text.xml')
| -rw-r--r-- | eclass-writing/text.xml | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 488230d..518cf2a 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -251,18 +251,19 @@ a single function, <c>domacosapp</c>. # Distributed under the terms of the GNU General Public License v2 # $Id$ -# -# Original Author: Ciaran McCreesh <ciaranm@gentoo.org> -# Purpose: install macos .app files to the relevant location. -# -# Bugs to osx@gentoo.org -# - -# domacosapp: install a macos .app file. Usage is 'domacosapp file' or -# 'domacosapp file newfile'. +# @ECLASS: macosapp.eclass +# @MAINTAINER: +# Ciaran McCreesh <ciaranm@gentoo.org> +# @BLURB: install macos .app files to the relevant location. +# @FUNCTION: domacosapp +# @USAGE: <app-file> [new-file] +# @DESCRIPTION: +# Install the given .app file into the appropriate location. If +# [new-file] is given, it will be used as the new (installed) name of +# the file. Otherwise <app-file> is installed as-is. domacosapp() { - [[ -z "${1}" ]] && die "usage: domacosapp <file> <new file>" + [[ -z "${1}" ]] && die "usage: domacosapp <file> [new file]" if use ppc-macos ; then insinto /Applications newins "$1" "${2:-${1}}" || die "Failed to install ${1}" |