/[gentoo-x86]/eclass/elisp.eclass
Gentoo

Diff of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.8 Revision 1.55
1# Copyright 1999-2003 Gentoo Technologies, Inc. 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.8 2003/09/21 01:40:41 mkennedy Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.55 2012/08/17 20:29:24 ulm Exp $
4# 4#
5# @ECLASS: elisp.eclass
6# @MAINTAINER:
7# Gentoo Emacs team <emacs@gentoo.org>
8# @AUTHOR:
5# Author Matthew Kennedy <mkennedy@gentoo.org> 9# Matthew Kennedy <mkennedy@gentoo.org>
10# Jeremy Maitin-Shepard <jbms@attbi.com>
11# Christian Faulhammer <fauli@gentoo.org>
12# Ulrich Müller <ulm@gentoo.org>
13# @BLURB: Eclass for Emacs Lisp packages
14# @DESCRIPTION:
6# 15#
7# This eclass sets the site-lisp directory for emacs-related packages. 16# This eclass is designed to install elisp files of Emacs related
17# packages into the site-lisp directory. The majority of elisp packages
18# will only need to define the standard ebuild variables (like SRC_URI)
19# and optionally SITEFILE for successful installation.
20#
21# Emacs support for other than pure elisp packages is handled by
22# elisp-common.eclass where you won't have a dependency on Emacs itself.
23# All elisp-* functions are documented there.
24#
25# If the package's source is a single (in whatever way) compressed elisp
26# file with the file name ${P}.el, then this eclass will move ${P}.el to
27# ${PN}.el in src_unpack().
8 28
9inherit elisp-common 29# @ECLASS-VARIABLE: NEED_EMACS
30# @DEFAULT_UNSET
31# @DESCRIPTION:
32# If you need anything different from Emacs 21, use the NEED_EMACS
33# variable before inheriting elisp.eclass. Set it to the major version
34# your package uses and the dependency will be adjusted.
10 35
11ECLASS=elisp 36# @ECLASS-VARIABLE: ELISP_PATCHES
12INHERITED="$INHERITED $ECLASS" 37# @DEFAULT_UNSET
38# @DESCRIPTION:
39# Space separated list of patches to apply after unpacking the sources.
40# Patch files are searched for in the current working dir, WORKDIR, and
41# FILESDIR.
13 42
14source /usr/portage/eclass/elisp-common.eclass 43# @ECLASS-VARIABLE: ELISP_REMOVE
44# @DEFAULT_UNSET
45# @DESCRIPTION:
46# Space separated list of files to remove after unpacking the sources.
15 47
16# SRC_URI should be set to wherever the primary app-emacs/ maintainer 48# @ECLASS-VARIABLE: SITEFILE
17# keeps the local elisp mirror, since most app-emacs packages are 49# @DEFAULT_UNSET
18# upstream as a single .el file. 50# @DESCRIPTION:
51# Name of package's site-init file. The filename must match the shell
52# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
53# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
54# in most cases.
19 55
20# Note: This is no longer necessary. 56# @ECLASS-VARIABLE: ELISP_TEXINFO
57# @DEFAULT_UNSET
58# @DESCRIPTION:
59# Space separated list of Texinfo sources. Respective GNU Info files
60# will be generated in src_compile() and installed in src_install().
21 61
22SRC_URI="http://cvs.gentoo.org/~mkennedy/app-emacs/${P}.el.bz2" 62# @ECLASS-VARIABLE: DOCS
23S="${WORKDIR}/" 63# @DEFAULT_UNSET
24newdepend "virtual/emacs" 64# @DESCRIPTION:
25IUSE="" 65# DOCS="blah.txt ChangeLog" is automatically used to install the given
66# files by dodoc in src_install().
26 67
27src_unpack() { 68inherit elisp-common eutils
28 unpack ${A} 69
29 if [ "${SIMPLE_ELISP}" = 't' ] 70case "${EAPI:-0}" in
30 then 71 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
31 cd ${S} && mv ${P}.el ${PN}.el 72 pkg_{setup,postinst,postrm} ;;
32 fi 73 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
74 pkg_{setup,postinst,postrm} ;;
75esac
76
77DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
78RDEPEND="${DEPEND}"
79
80# @FUNCTION: elisp_pkg_setup
81# @DESCRIPTION:
82# Test if the eselected Emacs version is sufficient to fulfil the major
83# version requirement of the NEED_EMACS variable.
84
85elisp_pkg_setup() {
86 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
33} 87}
34 88
35src_compile() { 89# @FUNCTION: elisp_src_unpack
36 emacs --batch -f batch-byte-compile --no-site-file --no-init-file *.el || die 90# @DESCRIPTION:
91# Unpack the sources; also handle the case of a single *.el file in
92# WORKDIR for packages distributed that way. For EAPIs without
93# src_prepare, call elisp_src_prepare.
94
95elisp_src_unpack() {
96 [[ -n ${A} ]] && unpack ${A}
97 if [[ -f ${P}.el ]]; then
98 # the "simple elisp" case with a single *.el file in WORKDIR
99 mv ${P}.el ${PN}.el || die
100 [[ -d ${S} ]] || S=${WORKDIR}
101 fi
102
103 case "${EAPI:-0}" in
104 0|1) [[ -d ${S} ]] && cd "${S}"
105 elisp_src_prepare ;;
106 esac
37} 107}
38 108
39src_install() { 109# @FUNCTION: elisp_src_prepare
40 elisp-install ${PN} *.el *.elc 110# @DESCRIPTION:
41 elisp-site-file-install ${FILESDIR}/${SITEFILE} 111# Apply any patches listed in ELISP_PATCHES. Patch files are searched
112# for in the current working dir, WORKDIR, and FILESDIR.
113
114elisp_src_prepare() {
115 local patch
116 for patch in ${ELISP_PATCHES}; do
117 if [[ -f ${patch} ]]; then
118 epatch "${patch}"
119 elif [[ -f ${WORKDIR}/${patch} ]]; then
120 epatch "${WORKDIR}/${patch}"
121 elif [[ -f ${FILESDIR}/${patch} ]]; then
122 epatch "${FILESDIR}/${patch}"
123 else
124 die "Cannot find ${patch}"
125 fi
126 done
127
128 # apply any user patches
129 epatch_user
130
131 if [[ -n ${ELISP_REMOVE} ]]; then
132 rm ${ELISP_REMOVE} || die
133 fi
42} 134}
43 135
136# @FUNCTION: elisp_src_configure
137# @DESCRIPTION:
138# Do nothing, because Emacs packages seldomly bring a full build system.
139
140elisp_src_configure() { :; }
141
142# @FUNCTION: elisp_src_compile
143# @DESCRIPTION:
144# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
145# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
146# GNU Info files from them.
147
148elisp_src_compile() {
149 elisp-compile *.el || die
150 if [[ -n ${ELISP_TEXINFO} ]]; then
151 makeinfo ${ELISP_TEXINFO} || die
152 fi
153}
154
155# @FUNCTION: elisp_src_install
156# @DESCRIPTION:
157# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
158# If the SITEFILE variable specifies a site-init file, install it with
159# elisp-site-file-install. Also install any GNU Info files listed in
160# ELISP_TEXINFO and documentation listed in the DOCS variable.
161
162elisp_src_install() {
163 elisp-install ${PN} *.el *.elc || die
164 if [[ -n ${SITEFILE} ]]; then
165 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
166 fi
167 if [[ -n ${ELISP_TEXINFO} ]]; then
168 set -- ${ELISP_TEXINFO}
169 set -- ${@##*/}
170 doinfo ${@/%.*/.info*} || die
171 fi
172 if [[ -n ${DOCS} ]]; then
173 dodoc ${DOCS} || die
174 fi
175}
176
177# @FUNCTION: elisp_pkg_postinst
178# @DESCRIPTION:
179# Call elisp-site-regen, in order to collect the site initialisation for
180# all installed Emacs Lisp packages in the site-gentoo.el file.
181
44pkg_postinst() { 182elisp_pkg_postinst() {
45 elisp-site-regen 183 elisp-site-regen
46} 184}
47 185
186# @FUNCTION: elisp_pkg_postrm
187# @DESCRIPTION:
188# Call elisp-site-regen, in order to collect the site initialisation for
189# all installed Emacs Lisp packages in the site-gentoo.el file.
190
48pkg_postrm() { 191elisp_pkg_postrm() {
49 elisp-site-regen 192 elisp-site-regen
50} 193}
51
52# Local Variables: ***
53# mode: shell-script ***
54# tab-width: 4 ***
55# indent-tabs-mode: t ***
56# End: ***
Legend:
Removed from v.1.8  
changed lines
  Added in v.1.55
  ViewVC Help
Powered by ViewVC 1.1.13