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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.54 - (show annotations) (download)
Sat Dec 3 08:54:46 2011 UTC (2 years, 7 months ago) by ulm
Branch: MAIN
Changes since 1.53: +13 -1 lines
Sync eclasses from Emacs overlay (revision 1752).
elisp.eclass: Allow for user patches. New variable ELISP_REMOVE.
elisp-common.eclass: Replace echo by einfo for proper logging.

1 # Copyright 1999-2011 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.53 2011/10/21 19:16:16 ulm Exp $
4 #
5 # @ECLASS: elisp.eclass
6 # @MAINTAINER:
7 # Gentoo Emacs team <emacs@gentoo.org>
8 # @AUTHOR:
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:
15 #
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().
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
68 inherit elisp-common eutils
69
70 case "${EAPI:-0}" in
71 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
72 pkg_{setup,postinst,postrm} ;;
73 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
74 pkg_{setup,postinst,postrm} ;;
75 esac
76
77 DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
78 RDEPEND="${DEPEND}"
79 IUSE=""
80
81 # @FUNCTION: elisp_pkg_setup
82 # @DESCRIPTION:
83 # Test if the eselected Emacs version is sufficient to fulfil the major
84 # version requirement of the NEED_EMACS variable.
85
86 elisp_pkg_setup() {
87 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
88 }
89
90 # @FUNCTION: elisp_src_unpack
91 # @DESCRIPTION:
92 # Unpack the sources; also handle the case of a single *.el file in
93 # WORKDIR for packages distributed that way. For EAPIs without
94 # src_prepare, call elisp_src_prepare.
95
96 elisp_src_unpack() {
97 [[ -n ${A} ]] && unpack ${A}
98 if [[ -f ${P}.el ]]; then
99 # the "simple elisp" case with a single *.el file in WORKDIR
100 mv ${P}.el ${PN}.el || die
101 [[ -d ${S} ]] || S=${WORKDIR}
102 fi
103
104 case "${EAPI:-0}" in
105 0|1) [[ -d ${S} ]] && cd "${S}"
106 elisp_src_prepare ;;
107 esac
108 }
109
110 # @FUNCTION: elisp_src_prepare
111 # @DESCRIPTION:
112 # Apply any patches listed in ELISP_PATCHES. Patch files are searched
113 # for in the current working dir, WORKDIR, and FILESDIR.
114
115 elisp_src_prepare() {
116 local patch
117 for patch in ${ELISP_PATCHES}; do
118 if [[ -f ${patch} ]]; then
119 epatch "${patch}"
120 elif [[ -f ${WORKDIR}/${patch} ]]; then
121 epatch "${WORKDIR}/${patch}"
122 elif [[ -f ${FILESDIR}/${patch} ]]; then
123 epatch "${FILESDIR}/${patch}"
124 else
125 die "Cannot find ${patch}"
126 fi
127 done
128
129 # apply any user patches
130 epatch_user
131
132 if [[ -n ${ELISP_REMOVE} ]]; then
133 rm ${ELISP_REMOVE} || die
134 fi
135 }
136
137 # @FUNCTION: elisp_src_configure
138 # @DESCRIPTION:
139 # Do nothing, because Emacs packages seldomly bring a full build system.
140
141 elisp_src_configure() { :; }
142
143 # @FUNCTION: elisp_src_compile
144 # @DESCRIPTION:
145 # Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
146 # If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
147 # GNU Info files from them.
148
149 elisp_src_compile() {
150 elisp-compile *.el || die
151 if [[ -n ${ELISP_TEXINFO} ]]; then
152 makeinfo ${ELISP_TEXINFO} || die
153 fi
154 }
155
156 # @FUNCTION: elisp_src_install
157 # @DESCRIPTION:
158 # Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
159 # If the SITEFILE variable specifies a site-init file, install it with
160 # elisp-site-file-install. Also install any GNU Info files listed in
161 # ELISP_TEXINFO and documentation listed in the DOCS variable.
162
163 elisp_src_install() {
164 elisp-install ${PN} *.el *.elc || die
165 if [[ -n ${SITEFILE} ]]; then
166 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
167 fi
168 if [[ -n ${ELISP_TEXINFO} ]]; then
169 set -- ${ELISP_TEXINFO}
170 set -- ${@##*/}
171 doinfo ${@/%.*/.info*} || die
172 fi
173 if [[ -n ${DOCS} ]]; then
174 dodoc ${DOCS} || die
175 fi
176 }
177
178 # @FUNCTION: elisp_pkg_postinst
179 # @DESCRIPTION:
180 # Call elisp-site-regen, in order to collect the site initialisation for
181 # all installed Emacs Lisp packages in the site-gentoo.el file.
182
183 elisp_pkg_postinst() {
184 elisp-site-regen
185 }
186
187 # @FUNCTION: elisp_pkg_postrm
188 # @DESCRIPTION:
189 # Call elisp-site-regen, in order to collect the site initialisation for
190 # all installed Emacs Lisp packages in the site-gentoo.el file.
191
192 elisp_pkg_postrm() {
193 elisp-site-regen
194 }

  ViewVC Help
Powered by ViewVC 1.1.20