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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.46 - (show annotations) (download)
Fri Sep 17 07:39:58 2010 UTC (4 years, 2 months ago) by ulm
Branch: MAIN
Changes since 1.45: +49 -6 lines
Update eclass documentation.

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

  ViewVC Help
Powered by ViewVC 1.1.20