diff options
| author |   Hans de Graaff <graaff@gentoo.org> | 2011-06-04 07:53:54 +0000 |
|---|---|---|
| committer | Hans de Graaff <graaff@gentoo.org> | 2011-06-04 07:53:54 +0000 |
| commit | 442af72524551c21b002235a171be0cbf3084157 (patch) | |
| tree | 48718ed34ab70ae73f3abfa55001b8385035fde9 /eclass/xemacs-packages.eclass | |
| parent | Documentation syntax fixes. (diff) | |
| download | gentoo-2-442af72524551c21b002235a171be0cbf3084157.tar.gz gentoo-2-442af72524551c21b002235a171be0cbf3084157.tar.bz2 gentoo-2-442af72524551c21b002235a171be0cbf3084157.zip | |
Add documentation.
Diffstat (limited to 'eclass/xemacs-packages.eclass')
| -rw-r--r-- | eclass/xemacs-packages.eclass | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/eclass/xemacs-packages.eclass b/eclass/xemacs-packages.eclass index 8fd7e8bf88e9..46822dd8bf3d 100644 --- a/eclass/xemacs-packages.eclass +++ b/eclass/xemacs-packages.eclass @@ -1,9 +1,13 @@ # Copyright 1999-2007 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 -# $Header: /var/cvsroot/gentoo-x86/eclass/xemacs-packages.eclass,v 1.17 2011/05/24 06:19:32 graaff Exp $ -# -# xemacs-packages eclass inherited by all xemacs packages -# $PKG_CAT need's to be set before inheriting xemacs-packages +# $Header: /var/cvsroot/gentoo-x86/eclass/xemacs-packages.eclass,v 1.18 2011/06/04 07:53:54 graaff Exp $ + +# @ECLASS: xemacs-packages.eclass +# @MAINTAINER: +# xemacs@gentoo.org +# @BLURB: Eclass to support elisp packages distributed by XEmacs. +# @DESCRIPTION: +# This eclass supports ebuilds for packages distributed by XEmacs. EXPORT_FUNCTIONS src_unpack src_compile src_install @@ -13,6 +17,12 @@ DEPEND="${DEPEND}" [ -z "$HOMEPAGE" ] && HOMEPAGE="http://xemacs.org/" [ -z "$LICENSE" ] && LICENSE="GPL-2" +# @ECLASS-VARIABLE: PKG_CAT +# @REQUIRED +# @DESCRIPTION: +# The package category that the package is in. Can be either standard, +# mule, or contrib. + case "${PKG_CAT}" in "standard" ) MY_INSTALL_DIR="/usr/lib/xemacs/xemacs-packages" ;; @@ -27,6 +37,14 @@ case "${PKG_CAT}" in esac [ -n "$DEBUG" ] && einfo "MY_INSTALL_DIR is ${MY_INSTALL_DIR}" +# @ECLASS-VARIABLE: EXPERIMENTAL +# @DEFAULT_UNSET +# @DESCRIPTION: +# If set then the package is downloaded from the experimental packages +# repository, which is the staging area for packages upstream. Packages +# in the experimental repository are auto-generated from XEmacs VCS, so +# they may not be well-tested. + if [ -n "$EXPERIMENTAL" ] then [ -z "$SRC_URI" ] && SRC_URI="http://ftp.xemacs.org/pub/xemacs/beta/experimental/packages/${P}-pkg.tar.gz" |