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

Diff of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.41 Revision 1.73
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.41 2008/07/01 22:10:06 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.73 2011/08/22 06:13:14 ulm Exp $
4#
5# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
10# 4#
11# @ECLASS: elisp-common.eclass 5# @ECLASS: elisp-common.eclass
12# @MAINTAINER: 6# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have 7# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14# problems, suggestions or questions. 8# have problems, suggestions or questions.
9# @AUTHOR:
10# Matthew Kennedy <mkennedy@gentoo.org>
11# Jeremy Maitin-Shepard <jbms@attbi.com>
12# Mamoru Komachi <usata@gentoo.org>
13# Christian Faulhammer <fauli@gentoo.org>
14# Ulrich Müller <ulm@gentoo.org>
15# @BLURB: Emacs-related installation utilities 15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION: 16# @DESCRIPTION:
17# 17#
18# Usually you want to use this eclass for (optional) GNU Emacs support of 18# Usually you want to use this eclass for (optional) GNU Emacs support
19# your package. This is NOT for XEmacs! 19# of your package. This is NOT for XEmacs!
20# 20#
21# Many of the steps here are sometimes done by the build system of your 21# Many of the steps here are sometimes done by the build system of your
22# package (especially compilation), so this is mainly for standalone elisp 22# package (especially compilation), so this is mainly for standalone
23# files you gathered from somewhere else. 23# elisp files you gathered from somewhere else.
24# 24#
25# When relying on the emacs USE flag, you need to add 25# When relying on the emacs USE flag, you need to add
26# 26#
27# emacs? ( virtual/emacs ) 27# emacs? ( virtual/emacs )
28# 28#
29# to your DEPEND/RDEPEND line and use the functions provided here to bring 29# to your DEPEND/RDEPEND line and use the functions provided here to
30# the files to the correct locations. 30# bring the files to the correct locations.
31#
32# If your package requires a minimum Emacs version, e.g. Emacs 23, then
33# the dependency should be on >=virtual/emacs-23 instead. Because the
34# user can select the Emacs executable with eselect, you should also
35# make sure that the active Emacs version is sufficient. This can be
36# tested with function elisp-need-emacs(), which would typically be
37# called from pkg_setup(), as in the following example:
38#
39# elisp-need-emacs 23 || die "Emacs version too low"
40#
41# Please note that such tests should be limited to packages that are
42# known to fail with lower Emacs versions; the standard case is to
43# depend on virtual/emacs without version.
31# 44#
32# .SS 45# .SS
33# src_compile() usage: 46# src_compile() usage:
34# 47#
35# An elisp file is compiled by the elisp-compile() function defined here and 48# An elisp file is compiled by the elisp-compile() function defined
36# simply takes the source files as arguments. 49# here and simply takes the source files as arguments. The case of
50# interdependent elisp files is also supported, since the current
51# directory is added to the load-path which makes sure that all files
52# are loadable.
37# 53#
38# elisp-compile *.el || die "elisp-compile failed" 54# elisp-compile *.el || die
39# 55#
40# In the case of interdependent elisp files, you can use the elisp-comp()
41# function which makes sure all files are loadable.
42#
43# elisp-comp *.el || die "elisp-comp failed"
44#
45# Function elisp-make-autoload-file() can be used to generate a file with 56# Function elisp-make-autoload-file() can be used to generate a file
46# autoload definitions for the lisp functions. It takes the output file name 57# with autoload definitions for the lisp functions. It takes the output
47# (default: "${PN}-autoloads.el") and a list of directories (default: working 58# file name (default: "${PN}-autoloads.el") and a list of directories
48# directory) as its arguments. Use of this function requires that the elisp 59# (default: working directory) as its arguments. Use of this function
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 60# requires that the elisp source files contain magic ";;;###autoload"
50# Reference Manual (node "Autoload") for a detailed explanation. 61# comments. See the Emacs Lisp Reference Manual (node "Autoload") for
62# a detailed explanation.
51# 63#
52# .SS 64# .SS
53# src_install() usage: 65# src_install() usage:
54# 66#
55# The resulting compiled files (.elc) should be put in a subdirectory of 67# The resulting compiled files (.elc) should be put in a subdirectory of
56# /usr/share/emacs/site-lisp/ which is named after the first argument 68# /usr/share/emacs/site-lisp/ which is named after the first argument
57# of elisp-install(). The following parameters are the files to be put in 69# of elisp-install(). The following parameters are the files to be put
58# that directory. Usually the subdirectory should be ${PN}, you can choose 70# in that directory. Usually the subdirectory should be ${PN}, you can
59# something else, but remember to tell elisp-site-file-install() (see below) 71# choose something else, but remember to tell elisp-site-file-install()
60# the change, as it defaults to ${PN}. 72# (see below) the change, as it defaults to ${PN}.
61# 73#
62# elisp-install ${PN} *.el *.elc || die "elisp-install failed" 74# elisp-install ${PN} *.el *.elc || die
63# 75#
64# To let the Emacs support be activated by Emacs on startup, you need 76# To let the Emacs support be activated by Emacs on startup, you need
65# to provide a site file (shipped in ${FILESDIR}) which contains the startup 77# to provide a site file (shipped in ${FILESDIR}) which contains the
66# code (have a look in the documentation of your software). Normally this 78# startup code (have a look in the documentation of your software).
67# would look like this: 79# Normally this would look like this:
68#
69# ;;; csv-mode site-lisp configuration
70# 80#
71# (add-to-list 'load-path "@SITELISP@") 81# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 82# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) 83# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74# 84#
75# If your Emacs support files are installed in a subdirectory of 85# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend 86# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
77# Emacs' load-path as shown in the first non-comment. 87# to extend Emacs' load-path as shown in the first non-comment line.
78# The elisp-site-file-install() function of this eclass will replace 88# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path. 89# "@SITELISP@" and "@SITEETC@" by the actual paths.
80# 90#
81# The next line tells Emacs to load the mode opening a file ending with 91# The next line tells Emacs to load the mode opening a file ending
82# ".csv" and load functions depending on the context and needed features. 92# with ".csv" and load functions depending on the context and needed
83# Be careful though. Commands as "load-library" or "require" bloat the 93# features. Be careful though. Commands as "load-library" or "require"
84# editor as they are loaded on every startup. When having a lot of Emacs 94# bloat the editor as they are loaded on every startup. When having
85# support files, users may be annoyed by the start-up time. Also avoid 95# many Emacs support files, users may be annoyed by the start-up time.
86# keybindings as they might interfere with the user's settings. Give a hint 96# Also avoid keybindings as they might interfere with the user's
87# in pkg_postinst(), which should be enough. 97# settings. Give a hint in pkg_postinst(), which should be enough.
88# 98#
89# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the 99# The naming scheme for this site-init file matches the shell pattern
90# two digits at the beginning define the loading order. So if you depend on 100# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
91# another Emacs package, your site file's number must be higher! 101# the loading order (numbers below 10 or above 89 are reserved for
102# internal use). So if your initialisation depends on another Emacs
103# package, your site file's number must be higher! If there are no such
104# interdependencies then the number should be 50. Otherwise, numbers
105# divisible by 10 are preferred.
92# 106#
93# Best practice is to define a SITEFILE variable in the global scope of your 107# Best practice is to define a SITEFILE variable in the global scope of
94# ebuild (right after DEPEND e.g.): 108# your ebuild (e.g., right after S or RDEPEND):
95# 109#
96# SITEFILE=50${PN}-gentoo.el 110# SITEFILE="50${PN}-gentoo.el"
97# 111#
98# Which is then installed by 112# Which is then installed by
99# 113#
100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 114# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101# 115#
116# in src_install(). Any characters after the "-gentoo" part and before
117# the extension will be stripped from the destination file's name.
118# For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
102# in src_install(). If your subdirectory is not named ${PN}, give the 119# "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
103# differing name as second argument. 120# the differing name as second argument.
104# 121#
105# .SS 122# .SS
106# pkg_postinst() / pkg_postrm() usage: 123# pkg_postinst() / pkg_postrm() usage:
107# 124#
108# After that you need to recreate the start-up file of Emacs after emerging 125# After that you need to recreate the start-up file of Emacs after
109# and unmerging by using 126# emerging and unmerging by using
110# 127#
111# pkg_postinst() { 128# pkg_postinst() {
112# elisp-site-regen 129# elisp-site-regen
113# } 130# }
114# 131#
115# pkg_postrm() { 132# pkg_postrm() {
116# elisp-site-regen 133# elisp-site-regen
117# } 134# }
118# 135#
119# When having optional Emacs support, you should prepend "use emacs &&" to 136# When having optional Emacs support, you should prepend "use emacs &&"
120# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"! 137# to above calls of elisp-site-regen().
121# When unmerging the state of the emacs USE flag is taken from the package 138# Don't use "has_version virtual/emacs"! When unmerging the state of
122# database and not from the environment, so it is no problem when you unset 139# the emacs USE flag is taken from the package database and not from the
140# environment, so it is no problem when you unset USE=emacs between
123# USE=emacs between merge and unmerge of a package. 141# merge and unmerge of a package.
124#
125# .SS
126# Miscellaneous functions:
127#
128# elisp-emacs-version() outputs the version of the currently active Emacs.
129 142
130# @ECLASS-VARIABLE: SITELISP 143# @ECLASS-VARIABLE: SITELISP
131# @DESCRIPTION: 144# @DESCRIPTION:
132# Directory where packages install Emacs Lisp files. 145# Directory where packages install Emacs Lisp files.
133SITELISP=/usr/share/emacs/site-lisp 146SITELISP=/usr/share/emacs/site-lisp
134 147
148# @ECLASS-VARIABLE: SITEETC
149# @DESCRIPTION:
135# Directory where packages install miscellaneous (not Lisp) files. 150# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc 151SITEETC=/usr/share/emacs/etc
137 152
138# @ECLASS-VARIABLE: SITEFILE 153# @ECLASS-VARIABLE: EMACS
139# @DESCRIPTION: 154# @DESCRIPTION:
140# Name of package's site-init file. 155# Path of Emacs executable.
141SITEFILE=50${PN}-gentoo.el
142
143EMACS=/usr/bin/emacs 156EMACS=${EPREFIX}/usr/bin/emacs
157
158# @ECLASS-VARIABLE: EMACSFLAGS
159# @DESCRIPTION:
160# Flags for executing Emacs in batch mode.
144# The following works for Emacs versions 18-23, don't change it. 161# These work for Emacs versions 18-23, so don't change them.
145EMACSFLAGS="-batch -q --no-site-file" 162EMACSFLAGS="-batch -q --no-site-file"
146 163
147# @FUNCTION: elisp-compile 164# @ECLASS-VARIABLE: BYTECOMPFLAGS
148# @USAGE: <list of elisp files>
149# @DESCRIPTION: 165# @DESCRIPTION:
150# Byte-compile Emacs Lisp files. 166# Emacs flags used for byte-compilation in elisp-compile().
151 167BYTECOMPFLAGS="-L ."
152elisp-compile() {
153 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed"
156}
157
158# @FUNCTION: elisp-comp
159# @USAGE: <list of elisp files>
160# @DESCRIPTION:
161# Byte-compile interdependent Emacs Lisp files.
162#
163# This function byte-compiles all ".el" files which are part of its
164# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
165# current directory, so disregarding the original directories used in ".el"
166# arguments.
167#
168# This function manages in such a way that all Emacs Lisp files to be
169# compiled are made visible between themselves, in the event they require or
170# load one another.
171
172elisp-comp() {
173 # Copyright 1995 Free Software Foundation, Inc.
174 # François Pinard <pinard@iro.umontreal.ca>, 1995.
175 # Originally taken from GNU autotools.
176
177 [ $# -gt 0 ] || return 1
178
179 ebegin "Compiling GNU Emacs Elisp files"
180
181 tempdir=elc.$$
182 mkdir ${tempdir}
183 cp "$@" ${tempdir}
184 pushd ${tempdir}
185
186 echo "(add-to-list 'load-path \"../\")" > script
187 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
188 local ret=$?
189 mv *.elc ..
190
191 popd
192 rm -fr ${tempdir}
193
194 eend ${ret} "batch-byte-compile failed"
195 return ${ret}
196}
197 168
198# @FUNCTION: elisp-emacs-version 169# @FUNCTION: elisp-emacs-version
199# @DESCRIPTION: 170# @DESCRIPTION:
200# Output version of currently active Emacs. 171# Output version of currently active Emacs.
201 172
202elisp-emacs-version() { 173elisp-emacs-version() {
174 local ret
203 # The following will work for at least versions 18-23. 175 # The following will work for at least versions 18-23.
204 echo "(princ emacs-version)" >"${T}"/emacs-version.el 176 echo "(princ emacs-version)" >"${T}"/emacs-version.el
205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el 177 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
178 ret=$?
206 rm -f "${T}"/emacs-version.el 179 rm -f "${T}"/emacs-version.el
180 if [[ ${ret} -ne 0 ]]; then
181 eerror "elisp-emacs-version: Failed to run ${EMACS}"
182 fi
183 return ${ret}
184}
185
186# @FUNCTION: elisp-need-emacs
187# @USAGE: <version>
188# @RETURN: 0 if true, 1 otherwise
189# @DESCRIPTION:
190# Test if the eselected Emacs version is at least the major version
191# specified as argument.
192
193elisp-need-emacs() {
194 local need_emacs=$1 have_emacs
195 have_emacs=$(elisp-emacs-version) || return
196 einfo "Emacs version: ${have_emacs}"
197 if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
198 eerror "This package needs at least Emacs ${need_emacs%%.*}."
199 eerror "Use \"eselect emacs\" to select the active version."
200 return 1
201 fi
202 return 0
203}
204
205# @FUNCTION: elisp-compile
206# @USAGE: <list of elisp files>
207# @DESCRIPTION:
208# Byte-compile Emacs Lisp files.
209#
210# This function uses GNU Emacs to byte-compile all ".el" specified by
211# its arguments. The resulting byte-code (".elc") files are placed in
212# the same directory as their corresponding source file.
213#
214# The current directory is added to the load-path. This will ensure
215# that interdependent Emacs Lisp files are visible between themselves,
216# in case they require or load one another.
217
218elisp-compile() {
219 ebegin "Compiling GNU Emacs Elisp files"
220 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
221 eend $? "elisp-compile: batch-byte-compile failed"
207} 222}
208 223
209# @FUNCTION: elisp-make-autoload-file 224# @FUNCTION: elisp-make-autoload-file
210# @USAGE: [output file] [list of directories] 225# @USAGE: [output file] [list of directories]
211# @DESCRIPTION: 226# @DESCRIPTION:
212# Generate a file with autoload definitions for the lisp functions. 227# Generate a file with autoload definitions for the lisp functions.
213 228
214elisp-make-autoload-file() { 229elisp-make-autoload-file() {
215 local f="${1:-${PN}-autoloads.el}" 230 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
216 shift 231 shift
217 ebegin "Generating autoload file for GNU Emacs" 232 ebegin "Generating autoload file for GNU Emacs"
218 233
219 sed 's/^FF/\f/' >"${f}" <<-EOF 234 cat >"${f}" <<-EOF
220 ;;; ${f##*/} --- autoloads for ${P} 235 ;;; ${f##*/} --- autoloads for ${PN}
221 236
222 ;;; Commentary: 237 ;;; Commentary:
223 ;; Automatically generated by elisp-common.eclass 238 ;; Automatically generated by elisp-common.eclass
224 ;; DO NOT EDIT THIS FILE 239 ;; DO NOT EDIT THIS FILE
225 240
226 ;;; Code: 241 ;;; Code:
227 FF 242 ${page}
228 ;; Local Variables: 243 ;; Local ${null}Variables:
229 ;; version-control: never 244 ;; version-control: never
230 ;; no-byte-compile: t 245 ;; no-byte-compile: t
231 ;; no-update-autoloads: t 246 ;; no-update-autoloads: t
232 ;; End: 247 ;; End:
248
233 ;;; ${f##*/} ends here 249 ;;; ${f##*/} ends here
234 EOF 250 EOF
235 251
236 ${EMACS} ${EMACSFLAGS} \ 252 ${EMACS} ${EMACSFLAGS} \
237 --eval "(setq make-backup-files nil)" \ 253 --eval "(setq make-backup-files nil)" \
238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 254 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
239 -f batch-update-autoloads "${@-.}" 255 -f batch-update-autoloads "${@-.}"
240 256
241 eend $? "batch-update-autoloads failed" 257 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
242} 258}
243 259
244# @FUNCTION: elisp-install 260# @FUNCTION: elisp-install
245# @USAGE: <subdirectory> <list of files> 261# @USAGE: <subdirectory> <list of files>
246# @DESCRIPTION: 262# @DESCRIPTION:
252 ebegin "Installing Elisp files for GNU Emacs support" 268 ebegin "Installing Elisp files for GNU Emacs support"
253 ( # subshell to avoid pollution of calling environment 269 ( # subshell to avoid pollution of calling environment
254 insinto "${SITELISP}/${subdir}" 270 insinto "${SITELISP}/${subdir}"
255 doins "$@" 271 doins "$@"
256 ) 272 )
257 eend $? "doins failed" 273 eend $? "elisp-install: doins failed"
258} 274}
259 275
260# @FUNCTION: elisp-site-file-install 276# @FUNCTION: elisp-site-file-install
261# @USAGE: <site-init file> [subdirectory] 277# @USAGE: <site-init file> [subdirectory]
262# @DESCRIPTION: 278# @DESCRIPTION:
263# Install Emacs site-init file in SITELISP directory. 279# Install Emacs site-init file in SITELISP directory. Automatically
280# inserts a standard comment header with the name of the package (unless
281# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
282# by the path to the package's subdirectory in SITELISP and SITEETC,
283# respectively.
264 284
265elisp-site-file-install() { 285elisp-site-file-install() {
266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret 286 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
287 local header=";;; ${PN} site-lisp configuration"
288
289 [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
290 || ewarn "elisp-site-file-install: bad name of site-init file"
291 sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
267 ebegin "Installing site initialisation file for GNU Emacs" 292 ebegin "Installing site initialisation file for GNU Emacs"
268 cp "$1" "${sf}" 293 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
294 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
269 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 295 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
270 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}" 296 -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
271 ( # subshell to avoid pollution of calling environment 297 ( # subshell to avoid pollution of calling environment
272 insinto "${SITELISP}/site-gentoo.d" 298 insinto "${SITELISP}/site-gentoo.d"
273 doins "${sf}" 299 doins "${sf}"
274 ) 300 )
275 ret=$? 301 ret=$?
276 rm -f "${sf}" 302 rm -f "${sf}"
277 eend ${ret} "doins failed" 303 eend ${ret} "elisp-site-file-install: doins failed"
278} 304}
279 305
280# @FUNCTION: elisp-site-regen 306# @FUNCTION: elisp-site-regen
281# @DESCRIPTION: 307# @DESCRIPTION:
282# Regenerate site-gentoo.el file. The old location for site initialisation 308# Regenerate the site-gentoo.el file, based on packages' site
283# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this 309# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
284# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of 310# directory.
285# packages with Emacs support is enough, the old location is still supported 311#
286# when generating the start-up file. 312# Note: Before December 2007, site initialisation files were installed
313# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
314# location is still supported when generating site-gentoo.el.
287 315
288elisp-site-regen() { 316elisp-site-regen() {
289 local i sf line obsolete 317 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
318 local sf i line null="" page=$'\f'
290 local -a sflist 319 local -a sflist
291 # Work around Paludis borkage: variable T is empty in pkg_postrm
292 local tmpdir=${T:-$(mktemp -d)}
293 320
294 if [ ! -d "${ROOT}${SITELISP}" ]; then 321 if [ ! -d "${sitelisp}" ]; then
295 eerror "Directory ${SITELISP} does not exist" 322 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
296 return 1 323 return 1
297 fi 324 fi
298 325
299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 326 if [ ! -d "${T}" ]; then
300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 327 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
301 einfo "Creating default ${SITELISP}/site-start.el ..." 328 return 1
302 cat <<-EOF >"${tmpdir}"/site-start.el
303 ;;; site-start.el
304
305 ;;; Commentary:
306 ;; This default site startup file is installed by elisp-common.eclass.
307 ;; You may replace this file by your own site initialisation, or even
308 ;; remove it completely; it will not be recreated.
309
310 ;;; Code:
311 ;; Load site initialisation for Gentoo-installed packages.
312 (require 'site-gentoo)
313
314 ;;; site-start.el ends here
315 EOF
316 fi 329 fi
317 330
318 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 331 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
319 332
320 # remove any auxiliary file (from previous run) 333 # Until January 2009, elisp-common.eclass sometimes created an
321 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el 334 # auxiliary file for backwards compatibility. Remove any such file.
335 rm -f "${sitelisp}"/00site-gentoo.el
322 336
323 # set nullglob option, there may be a directory without matching files
324 local old_shopts=$(shopt -p nullglob)
325 shopt -s nullglob
326
327 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \ 337 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
328 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el 338 "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
329 do 339 do
330 [ -r "${sf}" ] || continue 340 [ -r "${sf}" ] || continue
331 # sort files by their basename. straight insertion sort. 341 # sort files by their basename. straight insertion sort.
332 for ((i=${#sflist[@]}; i>0; i--)); do 342 for ((i=${#sflist[@]}; i>0; i--)); do
333 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break 343 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
334 sflist[i]=${sflist[i-1]} 344 sflist[i]=${sflist[i-1]}
335 done 345 done
336 sflist[i]=${sf} 346 sflist[i]=${sf}
337 # set a flag if there are obsolete files
338 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
339 done 347 done
340 348
341 eval "${old_shopts}"
342
343 cat <<-EOF >"${tmpdir}"/site-gentoo.el 349 cat <<-EOF >"${T}"/site-gentoo.el
344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 350 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
345 351
346 ;;; Commentary: 352 ;;; Commentary:
347 ;; Automatically generated by elisp-common.eclass 353 ;; Automatically generated by elisp-common.eclass
348 ;; DO NOT EDIT THIS FILE 354 ;; DO NOT EDIT THIS FILE
349 355
350 ;;; Code: 356 ;;; Code:
351 EOF 357 EOF
358 # Use sed instead of cat here, since files may miss a trailing newline.
352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el 359 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el 360 cat <<-EOF >>"${T}"/site-gentoo.el
354 361
362 ${page}
355 (provide 'site-gentoo) 363 (provide 'site-gentoo)
356 364
357 ;; Local Variables: 365 ;; Local ${null}Variables:
358 ;; no-byte-compile: t 366 ;; no-byte-compile: t
367 ;; buffer-read-only: t
359 ;; End: 368 ;; End:
369
360 ;;; site-gentoo.el ends here 370 ;;; site-gentoo.el ends here
361 EOF 371 EOF
362 372
363 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el 373 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
364 then
365 # This prevents outputting unnecessary text when there 374 # This prevents outputting unnecessary text when there
366 # was actually no change. 375 # was actually no change.
367 # A case is a remerge where we have doubled output. 376 # A case is a remerge where we have doubled output.
377 rm -f "${T}"/site-gentoo.el
368 echo " no changes." 378 echo " no changes."
369 else 379 else
370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 380 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
371 [ -f "${tmpdir}"/site-start.el ] \
372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
374 echo; einfo
375 for sf in "${sflist[@]##*/}"; do
376 einfo " Adding ${sf} ..."
377 done
378 einfo "Regenerated ${SITELISP}/site-gentoo.el."
379
380 echo 381 echo
381 while read line; do einfo "${line}"; done <<EOF 382 case ${#sflist[@]} in
382All site initialisation for Gentoo-installed packages is added to 383 0) ewarn "... Huh? No site initialisation files found." ;;
383/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 384 1) einfo "... ${#sflist[@]} site initialisation file included." ;;
384managed by Gentoo. You are responsible for all maintenance of 385 *) einfo "... ${#sflist[@]} site initialisation files included." ;;
385site-start.el if there is such a file. 386 esac
386
387In order for this site initialisation to be loaded for all users
388automatically, you can add a line like this:
389
390 (require 'site-gentoo)
391
392to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
393can be added by individual users to their initialisation files, or,
394for greater flexibility, users can load individual package-specific
395initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
396EOF
397 echo
398 fi 387 fi
399 388
400 if [ "${obsolete}" ]; then 389 return 0
401 while read line; do ewarn "${line}"; done <<-EOF
402 Site-initialisation files of Emacs packages are now installed in
403 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
404 that you use /usr/sbin/emacs-updater to rebuild the installed
405 Emacs packages.
406 EOF
407 echo
408
409 # Kludge for backwards compatibility: During pkg_postrm, old versions
410 # of this eclass (saved in the VDB) won't find packages' site-init
411 # files in the new location. So we copy them to an auxiliary file
412 # that is visible to old eclass versions.
413 for sf in "${sflist[@]}"; do
414 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
415 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
416 done
417 fi
418
419 # cleanup
420 rm -f "${tmpdir}"/site-{gentoo,start}.el
421} 390}

Legend:
Removed from v.1.41  
changed lines
  Added in v.1.73

  ViewVC Help
Powered by ViewVC 1.1.20