From a736c8672f3d7ecaa108a08ca2b6ec09b5281df4 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Thu, 2 Jun 2016 11:02:07 -0400 Subject: [PATCH 4/4] 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 <ciaranm@gentoo.org> -# 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 <devmanual@gentoo.org> +# @AUTHOR: +# Ciaran McCreesh <ciaranm@gentoo.org> +# @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" -- 2.7.3