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

Contents of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log


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

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.51 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.50 2011/08/22 06:13:14 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.46 # Any patches to apply after unpacking the sources. Patch files are
40     # searched for in the current working dir, WORKDIR, and FILESDIR.
41 ulm 1.40
42 ulm 1.38 # @ECLASS-VARIABLE: SITEFILE
43 ulm 1.45 # @DEFAULT_UNSET
44 ulm 1.23 # @DESCRIPTION:
45 ulm 1.38 # 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 opfer 1.19
50 ulm 1.43 # @ECLASS-VARIABLE: ELISP_TEXINFO
51 ulm 1.45 # @DEFAULT_UNSET
52 ulm 1.43 # @DESCRIPTION:
53 ulm 1.46 # Space separated list of Texinfo sources. Respective GNU Info files
54 ulm 1.43 # will be generated in src_compile() and installed in src_install().
55    
56     # @ECLASS-VARIABLE: DOCS
57 ulm 1.45 # @DEFAULT_UNSET
58 ulm 1.43 # @DESCRIPTION:
59     # DOCS="blah.txt ChangeLog" is automatically used to install the given
60     # files by dodoc in src_install().
61    
62 ulm 1.42 inherit elisp-common eutils
63 opfer 1.19
64 ulm 1.40 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 ulm 1.38
71 ulm 1.33 DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
72 ulm 1.40 RDEPEND="${DEPEND}"
73 opfer 1.19 IUSE=""
74 opfer 1.18
75 ulm 1.46 # @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 opfer 1.19 elisp_pkg_setup() {
81 ulm 1.47 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
82 opfer 1.19 }
83 mkennedy 1.1
84 ulm 1.46 # @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 opfer 1.18 elisp_src_unpack() {
91 ulm 1.33 [ -n "${A}" ] && unpack ${A}
92 ulm 1.30 if [ -f ${P}.el ]; then
93 ulm 1.39 # the "simple elisp" case with a single *.el file in WORKDIR
94 fauli 1.37 mv ${P}.el ${PN}.el || die
95 ulm 1.39 [ -d "${S}" ] || S=${WORKDIR}
96 opfer 1.18 fi
97 ulm 1.40
98     case "${EAPI:-0}" in
99 ulm 1.41 0|1) [ -d "${S}" ] && cd "${S}"
100     elisp_src_prepare ;;
101 ulm 1.40 esac
102     }
103    
104 ulm 1.46 # @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 ulm 1.40 elisp_src_prepare() {
110     local patch
111     for patch in ${ELISP_PATCHES}; do
112     if [ -f "${patch}" ]; then
113     epatch "${patch}"
114 ulm 1.44 elif [ -f "${WORKDIR}/${patch}" ]; then
115     epatch "${WORKDIR}/${patch}"
116 ulm 1.40 elif [ -f "${FILESDIR}/${patch}" ]; then
117     epatch "${FILESDIR}/${patch}"
118     else
119     die "Cannot find ${patch}"
120     fi
121     done
122 mkennedy 1.5 }
123    
124 ulm 1.46 # @FUNCTION: elisp_src_configure
125     # @DESCRIPTION:
126     # Do nothing, because Emacs packages seldomly bring a full build system.
127    
128 ulm 1.40 elisp_src_configure() { :; }
129    
130 ulm 1.46 # @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 ulm 1.48 # GNU Info files from them.
135 ulm 1.46
136 opfer 1.18 elisp_src_compile() {
137 ulm 1.35 elisp-compile *.el || die
138 ulm 1.43 if [ -n "${ELISP_TEXINFO}" ]; then
139     makeinfo ${ELISP_TEXINFO} || die
140     fi
141 mkennedy 1.5 }
142    
143 ulm 1.46 # @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 opfer 1.18 elisp_src_install() {
151 ulm 1.35 elisp-install ${PN} *.el *.elc || die
152     if [ -n "${SITEFILE}" ]; then
153     elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
154     fi
155 ulm 1.43 if [ -n "${ELISP_TEXINFO}" ]; then
156     set -- ${ELISP_TEXINFO}
157 ulm 1.49 set -- ${@##*/}
158 ulm 1.43 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