commit: 3fd0d856bf9e001b490f8af477a06033219823a7 Author: Michael Orlitzky <mjo <AT> gentoo <DOT> org> AuthorDate: Thu Jun 2 15:02:07 2016 +0000 Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org> CommitDate: Mon Oct 31 01:09:28 2016 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3fd0d856
eclass-writing: add documentation to the build system example. Now that we have guidelines for documenting eclasses, the "Simple Build System 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 | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index def2b89..9329d88 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -339,22 +339,41 @@ something like the following: # Distributed under the terms of the GNU General Public License v2 # $Id$ -# Original Author: Ciaran McCreesh <[email protected]> -# Purpose: Demonstration of EXPORT_FUNCTIONS. Defines simple wrappers for the -# (hypothetical) 'jmake' build system and a default src_compile. +# @ECLASS: jmake.eclass +# @MAINTAINER: +# Gentoo Devmanual Project <[email protected]> +# @AUTHOR: +# Ciaran McCreesh <[email protected]> +# @BLURB: Demonstrate a simple build system eclass. +# @DESCRIPTION: +# Demonstrates EXPORT_FUNCTIONS and defines simple wrappers for the +# (hypothetical) jmake build system and a default src_compile. EXPORT_FUNCTIONS src_compile DEPEND=">=sys-devel/jmake-2" +# @FUNCTION: jmake-configure +# @USAGE: [additional-args] +# @DESCRIPTION: +# Passes all arguments through to the appropriate "jmake configure" +# command. jmake-configure() { jmake configure --prefix=/usr "$@" } +# @FUNCTION: jmake-build +# @USAGE: [additional-args] +# @DESCRIPTION: +# First builds all dependencies, and then passes through its arguments +# to the appropriate "jmake build" command. jmake-build() { jmake dep && jmake build "$@" } +# @FUNCTION: jmake-src_compile +# @DESCRIPTION: +# Calls jmake-configure() and jmake-build() to compile a jmake project. jmake_src_compile() { jmake-configure || die "configure failed" jmake-build || die "build failed"
