From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id DB9E91395E2 for ; Mon, 31 Oct 2016 01:21:51 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 88786E0C06; Mon, 31 Oct 2016 01:21:49 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 701C5E0C06 for ; Mon, 31 Oct 2016 01:21:49 +0000 (UTC) Received: from oystercatcher.gentoo.org (unknown [IPv6:2a01:4f8:202:4333:225:90ff:fed9:fc84]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 1C65B341422 for ; Mon, 31 Oct 2016 01:21:48 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) by oystercatcher.gentoo.org (Postfix) with ESMTP id 2105124B0 for ; Mon, 31 Oct 2016 01:21:46 +0000 (UTC) From: "Göktürk Yüksek" To: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: 8bit Content-type: text/plain; charset=UTF-8 Reply-To: gentoo-dev@lists.gentoo.org, "Göktürk Yüksek" Message-ID: <1477876158.9b2cbaa0aa82b432293cf32f904197f4d7759e7e.gokturk@gentoo> Subject: [gentoo-commits] proj/devmanual:master commit in: eclass-writing/ X-VCS-Repository: proj/devmanual X-VCS-Files: eclass-writing/text.xml X-VCS-Directories: eclass-writing/ X-VCS-Committer: gokturk X-VCS-Committer-Name: Göktürk Yüksek X-VCS-Revision: 9b2cbaa0aa82b432293cf32f904197f4d7759e7e X-VCS-Branch: master Date: Mon, 31 Oct 2016 01:21:46 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org X-Archives-Salt: 4f7206c3-7772-47df-a309-905f8c5a89c7 X-Archives-Hash: 4cb51b32b1913460b982f9646f6ba26d commit: 9b2cbaa0aa82b432293cf32f904197f4d7759e7e Author: Michael Orlitzky gentoo org> AuthorDate: Thu Jun 2 14:42:34 2016 +0000 Commit: Göktürk Yüksek gentoo org> CommitDate: Mon Oct 31 01:09:18 2016 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=9b2cbaa0 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 eclass-writing/text.xml | 21 +++++++++++---------- 1 file 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, domacosapp. # 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}"