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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.51 - (show annotations) (download)
Mon Aug 22 06:56:26 2011 UTC (3 years, 4 months ago) by ulm
Branch: MAIN
Changes since 1.50: +2 -3 lines
Doc fix: @MAINTAINER doesn't support paragraphs any more.

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.50 2011/08/22 06:13:14 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 # Any patches to apply after unpacking the sources. Patch files are
40 # searched for in the current working dir, WORKDIR, and FILESDIR.
41
42 # @ECLASS-VARIABLE: SITEFILE
43 # @DEFAULT_UNSET
44 # @DESCRIPTION:
45 # Name of package's site-init file. The filename must match the shell
46 # pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
47 # reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
48 # in most cases.
49
50 # @ECLASS-VARIABLE: ELISP_TEXINFO
51 # @DEFAULT_UNSET
52 # @DESCRIPTION:
53 # Space separated list of Texinfo sources. Respective GNU Info files
54 # will be generated in src_compile() and installed in src_install().
55
56 # @ECLASS-VARIABLE: DOCS
57 # @DEFAULT_UNSET
58 # @DESCRIPTION:
59 # DOCS="blah.txt ChangeLog" is automatically used to install the given
60 # files by dodoc in src_install().
61
62 inherit elisp-common eutils
63
64 case "${EAPI:-0}" in
65 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
66 pkg_{setup,postinst,postrm} ;;
67 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
68 pkg_{setup,postinst,postrm} ;;
69 esac
70
71 DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
72 RDEPEND="${DEPEND}"
73 IUSE=""
74
75 # @FUNCTION: elisp_pkg_setup
76 # @DESCRIPTION:
77 # Test if the eselected Emacs version is sufficient to fulfil the major
78 # version requirement of the NEED_EMACS variable.
79
80 elisp_pkg_setup() {
81 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
82 }
83
84 # @FUNCTION: elisp_src_unpack
85 # @DESCRIPTION:
86 # Unpack the sources; also handle the case of a single *.el file in
87 # WORKDIR for packages distributed that way. For EAPIs without
88 # src_prepare, call elisp_src_prepare.
89
90 elisp_src_unpack() {
91 [ -n "${A}" ] && unpack ${A}
92 if [ -f ${P}.el ]; then
93 # the "simple elisp" case with a single *.el file in WORKDIR
94 mv ${P}.el ${PN}.el || die
95 [ -d "${S}" ] || S=${WORKDIR}
96 fi
97
98 case "${EAPI:-0}" in
99 0|1) [ -d "${S}" ] && cd "${S}"
100 elisp_src_prepare ;;
101 esac
102 }
103
104 # @FUNCTION: elisp_src_prepare
105 # @DESCRIPTION:
106 # Apply any patches listed in ELISP_PATCHES. Patch files are searched
107 # for in the current working dir, WORKDIR, and FILESDIR.
108
109 elisp_src_prepare() {
110 local patch
111 for patch in ${ELISP_PATCHES}; do
112 if [ -f "${patch}" ]; then
113 epatch "${patch}"
114 elif [ -f "${WORKDIR}/${patch}" ]; then
115 epatch "${WORKDIR}/${patch}"
116 elif [ -f "${FILESDIR}/${patch}" ]; then
117 epatch "${FILESDIR}/${patch}"
118 else
119 die "Cannot find ${patch}"
120 fi
121 done
122 }
123
124 # @FUNCTION: elisp_src_configure
125 # @DESCRIPTION:
126 # Do nothing, because Emacs packages seldomly bring a full build system.
127
128 elisp_src_configure() { :; }
129
130 # @FUNCTION: elisp_src_compile
131 # @DESCRIPTION:
132 # Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
133 # If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
134 # GNU Info files from them.
135
136 elisp_src_compile() {
137 elisp-compile *.el || die
138 if [ -n "${ELISP_TEXINFO}" ]; then
139 makeinfo ${ELISP_TEXINFO} || die
140 fi
141 }
142
143 # @FUNCTION: elisp_src_install
144 # @DESCRIPTION:
145 # Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
146 # If the SITEFILE variable specifies a site-init file, install it with
147 # elisp-site-file-install. Also install any GNU Info files listed in
148 # ELISP_TEXINFO and documentation listed in the DOCS variable.
149
150 elisp_src_install() {
151 elisp-install ${PN} *.el *.elc || die
152 if [ -n "${SITEFILE}" ]; then
153 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
154 fi
155 if [ -n "${ELISP_TEXINFO}" ]; then
156 set -- ${ELISP_TEXINFO}
157 set -- ${@##*/}
158 doinfo ${@/%.*/.info*} || die
159 fi
160 if [ -n "${DOCS}" ]; then
161 dodoc ${DOCS} || die
162 fi
163 }
164
165 # @FUNCTION: elisp_pkg_postinst
166 # @DESCRIPTION:
167 # Call elisp-site-regen, in order to collect the site initialisation for
168 # all installed Emacs Lisp packages in the site-gentoo.el file.
169
170 elisp_pkg_postinst() {
171 elisp-site-regen
172 }
173
174 # @FUNCTION: elisp_pkg_postrm
175 # @DESCRIPTION:
176 # Call elisp-site-regen, in order to collect the site initialisation for
177 # all installed Emacs Lisp packages in the site-gentoo.el file.
178
179 elisp_pkg_postrm() {
180 elisp-site-regen
181 }

  ViewVC Help
Powered by ViewVC 1.1.20