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

Diff of /eclass/elisp.eclass

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

Revision 1.1.1.1 Revision 1.57
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2013 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.1.1.1 2005/11/30 09:59:37 chriswhite Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.57 2013/03/16 08:55:30 ulm Exp $
4# 4#
5# @ECLASS: elisp.eclass
6# @MAINTAINER:
7# Gentoo Emacs team <emacs@gentoo.org>
8# @AUTHOR:
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org> 9# Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 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:
7# 15#
8# 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().
9 28
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.
35
36# @ECLASS-VARIABLE: ELISP_PATCHES
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.
42
43# @ECLASS-VARIABLE: ELISP_REMOVE
44# @DEFAULT_UNSET
45# @DESCRIPTION:
46# Space separated list of files to remove after unpacking the sources.
47
48# @ECLASS-VARIABLE: SITEFILE
49# @DEFAULT_UNSET
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.
55
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().
61
62# @ECLASS-VARIABLE: DOCS
63# @DEFAULT_UNSET
64# @DESCRIPTION:
65# DOCS="blah.txt ChangeLog" is automatically used to install the given
66# files by dodoc in src_install().
67
10inherit elisp-common 68inherit elisp-common eutils
11 69
12# SRC_URI should be set to wherever the primary app-emacs/ maintainer 70case "${EAPI:-0}" in
13# keeps the local elisp mirror, since most app-emacs packages are 71 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
14# upstream as a single .el file. 72 pkg_{setup,postinst,postrm} ;;
73 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
74 pkg_{setup,postinst,postrm} ;;
75esac
15 76
16# Note: This is no longer necessary. 77DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
78RDEPEND="${DEPEND}"
17 79
18SRC_URI="http://cvs.gentoo.org/~mkennedy/app-emacs/${P}.el.bz2" 80# @FUNCTION: elisp_pkg_setup
19if [ "${SIMPLE_ELISP}" = 't' ]; then 81# @DESCRIPTION:
20 S="${WORKDIR}/" 82# Test if the eselected Emacs version is sufficient to fulfil the major
21#else 83# version requirement of the NEED_EMACS variable.
22# Use default value
23# S="${WORKDIR}/${P}"
24fi
25 84
26DEPEND="virtual/emacs" 85elisp_pkg_setup() {
27IUSE="" 86 elisp-need-emacs "${NEED_EMACS:-21}"
87 case $? in
88 0) ;;
89 1) die "Emacs version too low" ;;
90 *) die "Could not determine Emacs version" ;;
91 esac
92}
93
94# @FUNCTION: elisp_src_unpack
95# @DESCRIPTION:
96# Unpack the sources; also handle the case of a single *.el file in
97# WORKDIR for packages distributed that way. For EAPIs without
98# src_prepare, call elisp_src_prepare.
28 99
29elisp_src_unpack() { 100elisp_src_unpack() {
30 unpack ${A} 101 [[ -n ${A} ]] && unpack ${A}
31 if [ "${SIMPLE_ELISP}" = 't' ] 102 if [[ -f ${P}.el ]]; then
32 then 103 # the "simple elisp" case with a single *.el file in WORKDIR
33 cd ${S} && mv ${P}.el ${PN}.el 104 mv ${P}.el ${PN}.el || die
105 [[ -d ${S} ]] || S=${WORKDIR}
106 fi
107
108 case "${EAPI:-0}" in
109 0|1) [[ -d ${S} ]] && cd "${S}"
110 elisp_src_prepare ;;
111 esac
112}
113
114# @FUNCTION: elisp_src_prepare
115# @DESCRIPTION:
116# Apply any patches listed in ELISP_PATCHES. Patch files are searched
117# for in the current working dir, WORKDIR, and FILESDIR.
118
119elisp_src_prepare() {
120 local patch
121 for patch in ${ELISP_PATCHES}; do
122 if [[ -f ${patch} ]]; then
123 epatch "${patch}"
124 elif [[ -f ${WORKDIR}/${patch} ]]; then
125 epatch "${WORKDIR}/${patch}"
126 elif [[ -f ${FILESDIR}/${patch} ]]; then
127 epatch "${FILESDIR}/${patch}"
128 else
129 die "Cannot find ${patch}"
34 fi 130 fi
131 done
132
133 # apply any user patches
134 epatch_user
135
136 if [[ -n ${ELISP_REMOVE} ]]; then
137 rm ${ELISP_REMOVE} || die
138 fi
35} 139}
140
141# @FUNCTION: elisp_src_configure
142# @DESCRIPTION:
143# Do nothing, because Emacs packages seldomly bring a full build system.
144
145elisp_src_configure() { :; }
146
147# @FUNCTION: elisp_src_compile
148# @DESCRIPTION:
149# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
150# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
151# GNU Info files from them.
36 152
37elisp_src_compile() { 153elisp_src_compile() {
38 elisp-compile *.el || die 154 elisp-compile *.el
155 if [[ -n ${ELISP_TEXINFO} ]]; then
156 makeinfo ${ELISP_TEXINFO} || die
157 fi
39} 158}
159
160# @FUNCTION: elisp_src_install
161# @DESCRIPTION:
162# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
163# If the SITEFILE variable specifies a site-init file, install it with
164# elisp-site-file-install. Also install any GNU Info files listed in
165# ELISP_TEXINFO and documentation listed in the DOCS variable.
40 166
41elisp_src_install() { 167elisp_src_install() {
42 elisp-install ${PN} *.el *.elc 168 elisp-install ${PN} *.el *.elc
169 if [[ -n ${SITEFILE} ]]; then
43 elisp-site-file-install ${FILESDIR}/${SITEFILE} 170 elisp-site-file-install "${FILESDIR}/${SITEFILE}"
171 fi
172 if [[ -n ${ELISP_TEXINFO} ]]; then
173 set -- ${ELISP_TEXINFO}
174 set -- ${@##*/}
175 doinfo ${@/%.*/.info*} || die
176 fi
177 if [[ -n ${DOCS} ]]; then
178 dodoc ${DOCS} || die
179 fi
180 if declare -f readme.gentoo_create_doc >/dev/null; then
181 readme.gentoo_create_doc
182 fi
44} 183}
184
185# @FUNCTION: elisp_pkg_postinst
186# @DESCRIPTION:
187# Call elisp-site-regen, in order to collect the site initialisation for
188# all installed Emacs Lisp packages in the site-gentoo.el file.
45 189
46elisp_pkg_postinst() { 190elisp_pkg_postinst() {
47 elisp-site-regen 191 elisp-site-regen
192 if declare -f readme.gentoo_print_elog >/dev/null; then
193 readme.gentoo_print_elog
194 fi
48} 195}
196
197# @FUNCTION: elisp_pkg_postrm
198# @DESCRIPTION:
199# Call elisp-site-regen, in order to collect the site initialisation for
200# all installed Emacs Lisp packages in the site-gentoo.el file.
49 201
50elisp_pkg_postrm() { 202elisp_pkg_postrm() {
51 elisp-site-regen 203 elisp-site-regen
52} 204}
53
54EXPORT_FUNCTIONS src_unpack src_compile src_install \
55 pkg_postinst pkg_postrm
56
57# Local Variables: ***
58# mode: shell-script ***
59# tab-width: 4 ***
60# indent-tabs-mode: t ***
61# End: ***

Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.57

  ViewVC Help
Powered by ViewVC 1.1.20