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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (hide annotations) (download)
Mon Feb 7 21:48:53 2011 UTC (3 years, 9 months ago) by ulm
Branch: MAIN
Changes since 1.47: +3 -3 lines
Fix typo.

1 ulm 1.48 # Copyright 1999-2011 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.48 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.47 2010/11/23 20:56:08 ulm Exp $
4 vapier 1.4 #
5 ulm 1.20 # Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
6 ulm 1.29 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7 ulm 1.46 # Copyright 2007-2010 Christian Faulhammer <fauli@gentoo.org>
8 ulm 1.44 # Copyright 2007-2010 Ulrich Müller <ulm@gentoo.org>
9 vapier 1.4 #
10 ulm 1.21 # @ECLASS: elisp.eclass
11     # @MAINTAINER:
12 ulm 1.24 # Feel free to contact the Emacs team through <emacs@gentoo.org> if you
13     # have problems, suggestions or questions.
14 ulm 1.21 # @BLURB: Eclass for Emacs Lisp packages
15     # @DESCRIPTION:
16     #
17 ulm 1.38 # This eclass is designed to install elisp files of Emacs related
18 ulm 1.46 # packages into the site-lisp directory. The majority of elisp packages
19 ulm 1.38 # will only need to define the standard ebuild variables (like SRC_URI)
20     # and optionally SITEFILE for successful installation.
21 opfer 1.17 #
22 opfer 1.18 # Emacs support for other than pure elisp packages is handled by
23 ulm 1.20 # elisp-common.eclass where you won't have a dependency on Emacs itself.
24     # All elisp-* functions are documented there.
25 ulm 1.30 #
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 ulm 1.23
30 ulm 1.38 # @ECLASS-VARIABLE: NEED_EMACS
31 ulm 1.45 # @DEFAULT_UNSET
32 ulm 1.35 # @DESCRIPTION:
33 ulm 1.38 # 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 ulm 1.35
37 ulm 1.40 # @ECLASS-VARIABLE: ELISP_PATCHES
38 ulm 1.45 # @DEFAULT_UNSET
39 ulm 1.40 # @DESCRIPTION:
40 ulm 1.46 # Any patches to apply after unpacking the sources. Patch files are
41     # searched for in the current working dir, WORKDIR, and FILESDIR.
42 ulm 1.40
43 ulm 1.38 # @ECLASS-VARIABLE: SITEFILE
44 ulm 1.45 # @DEFAULT_UNSET
45 ulm 1.23 # @DESCRIPTION:
46 ulm 1.38 # 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 opfer 1.19
51 ulm 1.43 # @ECLASS-VARIABLE: ELISP_TEXINFO
52 ulm 1.45 # @DEFAULT_UNSET
53 ulm 1.43 # @DESCRIPTION:
54 ulm 1.46 # Space separated list of Texinfo sources. Respective GNU Info files
55 ulm 1.43 # will be generated in src_compile() and installed in src_install().
56    
57     # @ECLASS-VARIABLE: DOCS
58 ulm 1.45 # @DEFAULT_UNSET
59 ulm 1.43 # @DESCRIPTION:
60     # DOCS="blah.txt ChangeLog" is automatically used to install the given
61     # files by dodoc in src_install().
62    
63 ulm 1.42 inherit elisp-common eutils
64 opfer 1.19
65 ulm 1.40 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 ulm 1.38
72 ulm 1.33 DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
73 ulm 1.40 RDEPEND="${DEPEND}"
74 opfer 1.19 IUSE=""
75 opfer 1.18
76 ulm 1.46 # @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 opfer 1.19 elisp_pkg_setup() {
82 ulm 1.47 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
83 opfer 1.19 }
84 mkennedy 1.1
85 ulm 1.46 # @FUNCTION: elisp_src_unpack
86     # @DESCRIPTION:
87     # Unpack the sources; also handle the case of a single *.el file in
88     # WORKDIR for packages distributed that way. For EAPIs without
89     # src_prepare, call elisp_src_prepare.
90    
91 opfer 1.18 elisp_src_unpack() {
92 ulm 1.33 [ -n "${A}" ] && unpack ${A}
93 ulm 1.30 if [ -f ${P}.el ]; then
94 ulm 1.39 # the "simple elisp" case with a single *.el file in WORKDIR
95 fauli 1.37 mv ${P}.el ${PN}.el || die
96 ulm 1.39 [ -d "${S}" ] || S=${WORKDIR}
97 opfer 1.18 fi
98 ulm 1.40
99     case "${EAPI:-0}" in
100 ulm 1.41 0|1) [ -d "${S}" ] && cd "${S}"
101     elisp_src_prepare ;;
102 ulm 1.40 esac
103     }
104    
105 ulm 1.46 # @FUNCTION: elisp_src_prepare
106     # @DESCRIPTION:
107     # Apply any patches listed in ELISP_PATCHES. Patch files are searched
108     # for in the current working dir, WORKDIR, and FILESDIR.
109    
110 ulm 1.40 elisp_src_prepare() {
111     local patch
112     for patch in ${ELISP_PATCHES}; do
113     if [ -f "${patch}" ]; then
114     epatch "${patch}"
115 ulm 1.44 elif [ -f "${WORKDIR}/${patch}" ]; then
116     epatch "${WORKDIR}/${patch}"
117 ulm 1.40 elif [ -f "${FILESDIR}/${patch}" ]; then
118     epatch "${FILESDIR}/${patch}"
119     else
120     die "Cannot find ${patch}"
121     fi
122     done
123 mkennedy 1.5 }
124    
125 ulm 1.46 # @FUNCTION: elisp_src_configure
126     # @DESCRIPTION:
127     # Do nothing, because Emacs packages seldomly bring a full build system.
128    
129 ulm 1.40 elisp_src_configure() { :; }
130    
131 ulm 1.46 # @FUNCTION: elisp_src_compile
132     # @DESCRIPTION:
133     # Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
134     # If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
135 ulm 1.48 # GNU Info files from them.
136 ulm 1.46
137 opfer 1.18 elisp_src_compile() {
138 ulm 1.35 elisp-compile *.el || die
139 ulm 1.43 if [ -n "${ELISP_TEXINFO}" ]; then
140     makeinfo ${ELISP_TEXINFO} || die
141     fi
142 mkennedy 1.5 }
143    
144 ulm 1.46 # @FUNCTION: elisp_src_install
145     # @DESCRIPTION:
146     # Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
147     # If the SITEFILE variable specifies a site-init file, install it with
148     # elisp-site-file-install. Also install any GNU Info files listed in
149     # ELISP_TEXINFO and documentation listed in the DOCS variable.
150    
151 opfer 1.18 elisp_src_install() {
152 ulm 1.35 elisp-install ${PN} *.el *.elc || die
153     if [ -n "${SITEFILE}" ]; then
154     elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
155     fi
156 ulm 1.43 if [ -n "${ELISP_TEXINFO}" ]; then
157     set -- ${ELISP_TEXINFO}
158     doinfo ${@/%.*/.info*} || die
159     fi
160 opfer 1.19 if [ -n "${DOCS}" ]; then
161 fauli 1.37 dodoc ${DOCS} || die
162 opfer 1.19 fi
163 mkennedy 1.5 }
164    
165 ulm 1.46 # @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 opfer 1.18 elisp_pkg_postinst() {
171     elisp-site-regen
172 mkennedy 1.5 }
173    
174 ulm 1.46 # @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 opfer 1.18 elisp_pkg_postrm() {
180     elisp-site-regen
181 mkennedy 1.5 }

  ViewVC Help
Powered by ViewVC 1.1.20