From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1OwVYH-0005jq-RR for garchives@archives.gentoo.org; Fri, 17 Sep 2010 07:40:10 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 1FF6CE0976; Fri, 17 Sep 2010 07:40:01 +0000 (UTC) Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183]) by pigeon.gentoo.org (Postfix) with ESMTP id D2700E098F for ; Fri, 17 Sep 2010 07:40:00 +0000 (UTC) Received: from flycatcher.gentoo.org (flycatcher.gentoo.org [81.93.255.6]) (using TLSv1 with cipher ADH-CAMELLIA256-SHA (256/256 bits)) (No client certificate requested) by smtp.gentoo.org (Postfix) with ESMTPS id 309D064EB7 for ; Fri, 17 Sep 2010 07:40:00 +0000 (UTC) Received: by flycatcher.gentoo.org (Postfix, from userid 2178) id B9A1A20051; Fri, 17 Sep 2010 07:39:58 +0000 (UTC) From: "Ulrich Mueller (ulm)" To: gentoo-commits@lists.gentoo.org Reply-To: gentoo-dev@lists.gentoo.org, ulm@gentoo.org Subject: [gentoo-commits] gentoo-x86 commit in eclass: elisp.eclass X-VCS-Repository: gentoo-x86 X-VCS-Files: elisp.eclass X-VCS-Directories: eclass X-VCS-Committer: ulm X-VCS-Committer-Name: Ulrich Mueller Content-Type: text/plain; charset=utf8 Message-Id: <20100917073958.B9A1A20051@flycatcher.gentoo.org> Date: Fri, 17 Sep 2010 07:39:58 +0000 (UTC) Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-commits@lists.gentoo.org Content-Transfer-Encoding: quoted-printable X-Archives-Salt: 40a85233-94b9-4f40-8ef0-76a489fa0eab X-Archives-Hash: 5df43165d193400a5f1509a0fc3eff0b ulm 10/09/17 07:39:58 Modified: elisp.eclass Log: Update eclass documentation. Revision Changes Path 1.46 eclass/elisp.eclass file : http://sources.gentoo.org/viewvc.cgi/gentoo-x86/eclass/elisp.eclas= s?rev=3D1.46&view=3Dmarkup plain: http://sources.gentoo.org/viewvc.cgi/gentoo-x86/eclass/elisp.eclas= s?rev=3D1.46&content-type=3Dtext/plain diff : http://sources.gentoo.org/viewvc.cgi/gentoo-x86/eclass/elisp.eclas= s?r1=3D1.45&r2=3D1.46 Index: elisp.eclass =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D RCS file: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v retrieving revision 1.45 retrieving revision 1.46 diff -u -r1.45 -r1.46 --- elisp.eclass 22 Aug 2010 08:30:32 -0000 1.45 +++ elisp.eclass 17 Sep 2010 07:39:58 -0000 1.46 @@ -1,10 +1,10 @@ # Copyright 1999-2010 Gentoo Foundation # Distributed under the terms of the GNU General Public License v2 -# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.45 2010/08/22= 08:30:32 ulm Exp $ +# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.46 2010/09/17= 07:39:58 ulm Exp $ # # Copyright 2002-2003 Matthew Kennedy # Copyright 2003 Jeremy Maitin-Shepard -# Copyright 2007-2009 Christian Faulhammer +# Copyright 2007-2010 Christian Faulhammer # Copyright 2007-2010 Ulrich M=C3=BCller # # @ECLASS: elisp.eclass @@ -15,7 +15,7 @@ # @DESCRIPTION: # # This eclass is designed to install elisp files of Emacs related -# packages into the site-lisp directory. The majority of elisp packages +# packages into the site-lisp directory. The majority of elisp packages # will only need to define the standard ebuild variables (like SRC_URI) # and optionally SITEFILE for successful installation. # @@ -37,8 +37,8 @@ # @ECLASS-VARIABLE: ELISP_PATCHES # @DEFAULT_UNSET # @DESCRIPTION: -# Any patches to apply after unpacking the sources. Patches are searched -# both in ${PWD} and ${FILESDIR}. +# Any patches to apply after unpacking the sources. Patch files are +# searched for in the current working dir, WORKDIR, and FILESDIR. =20 # @ECLASS-VARIABLE: SITEFILE # @DEFAULT_UNSET @@ -51,7 +51,7 @@ # @ECLASS-VARIABLE: ELISP_TEXINFO # @DEFAULT_UNSET # @DESCRIPTION: -# Space separated list of Texinfo sources. Respective GNU Info files +# Space separated list of Texinfo sources. Respective GNU Info files # will be generated in src_compile() and installed in src_install(). =20 # @ECLASS-VARIABLE: DOCS @@ -73,6 +73,11 @@ RDEPEND=3D"${DEPEND}" IUSE=3D"" =20 +# @FUNCTION: elisp_pkg_setup +# @DESCRIPTION: +# Test if the eselected Emacs version is sufficient to fulfil the major +# version requirement of the NEED_EMACS variable. + elisp_pkg_setup() { local need_emacs=3D${NEED_EMACS:-21} local have_emacs=3D$(elisp-emacs-version) @@ -84,6 +89,12 @@ einfo "Emacs version: ${have_emacs}" } =20 +# @FUNCTION: elisp_src_unpack +# @DESCRIPTION: +# Unpack the sources; also handle the case of a single *.el file in +# WORKDIR for packages distributed that way. For EAPIs without +# src_prepare, call elisp_src_prepare. + elisp_src_unpack() { [ -n "${A}" ] && unpack ${A} if [ -f ${P}.el ]; then @@ -98,6 +109,11 @@ esac } =20 +# @FUNCTION: elisp_src_prepare +# @DESCRIPTION: +# Apply any patches listed in ELISP_PATCHES. Patch files are searched +# for in the current working dir, WORKDIR, and FILESDIR. + elisp_src_prepare() { local patch for patch in ${ELISP_PATCHES}; do @@ -113,8 +129,18 @@ done } =20 +# @FUNCTION: elisp_src_configure +# @DESCRIPTION: +# Do nothing, because Emacs packages seldomly bring a full build system. + elisp_src_configure() { :; } =20 +# @FUNCTION: elisp_src_compile +# @DESCRIPTION: +# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files. +# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate +# GNU Info files from then. + elisp_src_compile() { elisp-compile *.el || die if [ -n "${ELISP_TEXINFO}" ]; then @@ -122,6 +148,13 @@ fi } =20 +# @FUNCTION: elisp_src_install +# @DESCRIPTION: +# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files. +# If the SITEFILE variable specifies a site-init file, install it with +# elisp-site-file-install. Also install any GNU Info files listed in +# ELISP_TEXINFO and documentation listed in the DOCS variable. + elisp_src_install() { elisp-install ${PN} *.el *.elc || die if [ -n "${SITEFILE}" ]; then @@ -136,10 +169,20 @@ fi } =20 +# @FUNCTION: elisp_pkg_postinst +# @DESCRIPTION: +# Call elisp-site-regen, in order to collect the site initialisation for +# all installed Emacs Lisp packages in the site-gentoo.el file. + elisp_pkg_postinst() { elisp-site-regen } =20 +# @FUNCTION: elisp_pkg_postrm +# @DESCRIPTION: +# Call elisp-site-regen, in order to collect the site initialisation for +# all installed Emacs Lisp packages in the site-gentoo.el file. + elisp_pkg_postrm() { elisp-site-regen }