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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.54 - (hide annotations) (download)
Sat Dec 3 08:54:46 2011 UTC (2 years, 8 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 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.54 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.53 2011/10/21 19:16:16 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.38 # 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 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.33 DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
78 ulm 1.40 RDEPEND="${DEPEND}"
79 opfer 1.19 IUSE=""
80 opfer 1.18
81 ulm 1.46 # @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 opfer 1.19 elisp_pkg_setup() {
87 ulm 1.47 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
88 opfer 1.19 }
89 mkennedy 1.1
90 ulm 1.46 # @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 opfer 1.18 elisp_src_unpack() {
97 ulm 1.52 [[ -n ${A} ]] && unpack ${A}
98     if [[ -f ${P}.el ]]; then
99 ulm 1.39 # the "simple elisp" case with a single *.el file in WORKDIR
100 fauli 1.37 mv ${P}.el ${PN}.el || die
101 ulm 1.52 [[ -d ${S} ]] || S=${WORKDIR}
102 opfer 1.18 fi
103 ulm 1.40
104     case "${EAPI:-0}" in
105 ulm 1.52 0|1) [[ -d ${S} ]] && cd "${S}"
106 ulm 1.41 elisp_src_prepare ;;
107 ulm 1.40 esac
108     }
109    
110 ulm 1.46 # @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 ulm 1.40 elisp_src_prepare() {
116     local patch
117     for patch in ${ELISP_PATCHES}; do
118 ulm 1.52 if [[ -f ${patch} ]]; then
119 ulm 1.40 epatch "${patch}"
120 ulm 1.52 elif [[ -f ${WORKDIR}/${patch} ]]; then
121 ulm 1.44 epatch "${WORKDIR}/${patch}"
122 ulm 1.52 elif [[ -f ${FILESDIR}/${patch} ]]; then
123 ulm 1.40 epatch "${FILESDIR}/${patch}"
124     else
125     die "Cannot find ${patch}"
126     fi
127     done
128 ulm 1.54
129     # apply any user patches
130     epatch_user
131    
132     if [[ -n ${ELISP_REMOVE} ]]; then
133     rm ${ELISP_REMOVE} || die
134     fi
135 mkennedy 1.5 }
136    
137 ulm 1.46 # @FUNCTION: elisp_src_configure
138     # @DESCRIPTION:
139     # Do nothing, because Emacs packages seldomly bring a full build system.
140    
141 ulm 1.40 elisp_src_configure() { :; }
142    
143 ulm 1.46 # @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 ulm 1.48 # GNU Info files from them.
148 ulm 1.46
149 opfer 1.18 elisp_src_compile() {
150 ulm 1.35 elisp-compile *.el || die
151 ulm 1.52 if [[ -n ${ELISP_TEXINFO} ]]; then
152 ulm 1.43 makeinfo ${ELISP_TEXINFO} || die
153     fi
154 mkennedy 1.5 }
155    
156 ulm 1.46 # @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 opfer 1.18 elisp_src_install() {
164 ulm 1.35 elisp-install ${PN} *.el *.elc || die
165 ulm 1.52 if [[ -n ${SITEFILE} ]]; then
166 ulm 1.35 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
167     fi
168 ulm 1.52 if [[ -n ${ELISP_TEXINFO} ]]; then
169 ulm 1.43 set -- ${ELISP_TEXINFO}
170 ulm 1.49 set -- ${@##*/}
171 ulm 1.43 doinfo ${@/%.*/.info*} || die
172     fi
173 ulm 1.52 if [[ -n ${DOCS} ]]; then
174 fauli 1.37 dodoc ${DOCS} || die
175 opfer 1.19 fi
176 mkennedy 1.5 }
177    
178 ulm 1.46 # @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 opfer 1.18 elisp_pkg_postinst() {
184     elisp-site-regen
185 mkennedy 1.5 }
186    
187 ulm 1.46 # @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 opfer 1.18 elisp_pkg_postrm() {
193     elisp-site-regen
194 mkennedy 1.5 }

  ViewVC Help
Powered by ViewVC 1.1.20