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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.58 - (hide annotations) (download)
Sat Jun 7 10:28:16 2014 UTC (5 months, 2 weeks ago) by ulm
Branch: MAIN
CVS Tags: HEAD
Changes since 1.57: +5 -5 lines
Increase minimum Emacs version to 23, versions 21 and 22 have been removed.

1 ulm 1.58 # Copyright 1999-2014 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.58 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.57 2013/03/16 08:55:30 ulm Exp $
4 vapier 1.4 #
5 ulm 1.21 # @ECLASS: elisp.eclass
6     # @MAINTAINER:
7 ulm 1.51 # Gentoo Emacs team <emacs@gentoo.org>
8 ulm 1.50 # @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 ulm 1.21 # @BLURB: Eclass for Emacs Lisp packages
14     # @DESCRIPTION:
15     #
16 ulm 1.38 # This eclass is designed to install elisp files of Emacs related
17 ulm 1.46 # packages into the site-lisp directory. The majority of elisp packages
18 ulm 1.38 # will only need to define the standard ebuild variables (like SRC_URI)
19     # and optionally SITEFILE for successful installation.
20 opfer 1.17 #
21 opfer 1.18 # Emacs support for other than pure elisp packages is handled by
22 ulm 1.20 # elisp-common.eclass where you won't have a dependency on Emacs itself.
23     # All elisp-* functions are documented there.
24 ulm 1.30 #
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 ulm 1.23
29 ulm 1.38 # @ECLASS-VARIABLE: NEED_EMACS
30 ulm 1.45 # @DEFAULT_UNSET
31 ulm 1.35 # @DESCRIPTION:
32 ulm 1.58 # If you need anything different from Emacs 23, use the NEED_EMACS
33 ulm 1.38 # variable before inheriting elisp.eclass. Set it to the major version
34     # your package uses and the dependency will be adjusted.
35 ulm 1.35
36 ulm 1.40 # @ECLASS-VARIABLE: ELISP_PATCHES
37 ulm 1.45 # @DEFAULT_UNSET
38 ulm 1.40 # @DESCRIPTION:
39 ulm 1.53 # 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 ulm 1.40
43 ulm 1.54 # @ECLASS-VARIABLE: ELISP_REMOVE
44     # @DEFAULT_UNSET
45     # @DESCRIPTION:
46     # Space separated list of files to remove after unpacking the sources.
47    
48 ulm 1.38 # @ECLASS-VARIABLE: SITEFILE
49 ulm 1.45 # @DEFAULT_UNSET
50 ulm 1.23 # @DESCRIPTION:
51 ulm 1.38 # 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 opfer 1.19
56 ulm 1.43 # @ECLASS-VARIABLE: ELISP_TEXINFO
57 ulm 1.45 # @DEFAULT_UNSET
58 ulm 1.43 # @DESCRIPTION:
59 ulm 1.46 # Space separated list of Texinfo sources. Respective GNU Info files
60 ulm 1.43 # will be generated in src_compile() and installed in src_install().
61    
62     # @ECLASS-VARIABLE: DOCS
63 ulm 1.45 # @DEFAULT_UNSET
64 ulm 1.43 # @DESCRIPTION:
65     # DOCS="blah.txt ChangeLog" is automatically used to install the given
66     # files by dodoc in src_install().
67    
68 ulm 1.42 inherit elisp-common eutils
69 opfer 1.19
70 ulm 1.40 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 ulm 1.38
77 ulm 1.58 DEPEND=">=virtual/emacs-${NEED_EMACS:-23}"
78 ulm 1.40 RDEPEND="${DEPEND}"
79 opfer 1.18
80 ulm 1.46 # @FUNCTION: elisp_pkg_setup
81     # @DESCRIPTION:
82     # Test if the eselected Emacs version is sufficient to fulfil the major
83     # version requirement of the NEED_EMACS variable.
84    
85 opfer 1.19 elisp_pkg_setup() {
86 ulm 1.58 elisp-need-emacs "${NEED_EMACS:-23}"
87 ulm 1.56 case $? in
88     0) ;;
89     1) die "Emacs version too low" ;;
90     *) die "Could not determine Emacs version" ;;
91     esac
92 opfer 1.19 }
93 mkennedy 1.1
94 ulm 1.46 # @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.
99    
100 opfer 1.18 elisp_src_unpack() {
101 ulm 1.52 [[ -n ${A} ]] && unpack ${A}
102     if [[ -f ${P}.el ]]; then
103 ulm 1.39 # the "simple elisp" case with a single *.el file in WORKDIR
104 fauli 1.37 mv ${P}.el ${PN}.el || die
105 ulm 1.52 [[ -d ${S} ]] || S=${WORKDIR}
106 opfer 1.18 fi
107 ulm 1.40
108     case "${EAPI:-0}" in
109 ulm 1.52 0|1) [[ -d ${S} ]] && cd "${S}"
110 ulm 1.41 elisp_src_prepare ;;
111 ulm 1.40 esac
112     }
113    
114 ulm 1.46 # @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    
119 ulm 1.40 elisp_src_prepare() {
120     local patch
121     for patch in ${ELISP_PATCHES}; do
122 ulm 1.52 if [[ -f ${patch} ]]; then
123 ulm 1.40 epatch "${patch}"
124 ulm 1.52 elif [[ -f ${WORKDIR}/${patch} ]]; then
125 ulm 1.44 epatch "${WORKDIR}/${patch}"
126 ulm 1.52 elif [[ -f ${FILESDIR}/${patch} ]]; then
127 ulm 1.40 epatch "${FILESDIR}/${patch}"
128     else
129     die "Cannot find ${patch}"
130     fi
131     done
132 ulm 1.54
133     # apply any user patches
134     epatch_user
135    
136     if [[ -n ${ELISP_REMOVE} ]]; then
137     rm ${ELISP_REMOVE} || die
138     fi
139 mkennedy 1.5 }
140    
141 ulm 1.46 # @FUNCTION: elisp_src_configure
142     # @DESCRIPTION:
143     # Do nothing, because Emacs packages seldomly bring a full build system.
144    
145 ulm 1.40 elisp_src_configure() { :; }
146    
147 ulm 1.46 # @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 ulm 1.48 # GNU Info files from them.
152 ulm 1.46
153 opfer 1.18 elisp_src_compile() {
154 ulm 1.57 elisp-compile *.el
155 ulm 1.52 if [[ -n ${ELISP_TEXINFO} ]]; then
156 ulm 1.43 makeinfo ${ELISP_TEXINFO} || die
157     fi
158 mkennedy 1.5 }
159    
160 ulm 1.46 # @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.
166    
167 opfer 1.18 elisp_src_install() {
168 ulm 1.57 elisp-install ${PN} *.el *.elc
169 ulm 1.52 if [[ -n ${SITEFILE} ]]; then
170 ulm 1.57 elisp-site-file-install "${FILESDIR}/${SITEFILE}"
171 ulm 1.35 fi
172 ulm 1.52 if [[ -n ${ELISP_TEXINFO} ]]; then
173 ulm 1.43 set -- ${ELISP_TEXINFO}
174 ulm 1.49 set -- ${@##*/}
175 ulm 1.43 doinfo ${@/%.*/.info*} || die
176     fi
177 ulm 1.52 if [[ -n ${DOCS} ]]; then
178 fauli 1.37 dodoc ${DOCS} || die
179 opfer 1.19 fi
180 ulm 1.57 if declare -f readme.gentoo_create_doc >/dev/null; then
181     readme.gentoo_create_doc
182     fi
183 mkennedy 1.5 }
184    
185 ulm 1.46 # @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.
189    
190 opfer 1.18 elisp_pkg_postinst() {
191     elisp-site-regen
192 ulm 1.57 if declare -f readme.gentoo_print_elog >/dev/null; then
193     readme.gentoo_print_elog
194     fi
195 mkennedy 1.5 }
196    
197 ulm 1.46 # @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.
201    
202 opfer 1.18 elisp_pkg_postrm() {
203     elisp-site-regen
204 mkennedy 1.5 }

  ViewVC Help
Powered by ViewVC 1.1.20