summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2013-09-04 21:12:07 +0200
committerUlrich Müller <ulm@gentoo.org>2013-09-04 21:12:07 +0200
commitcf86331609a3e82f99313edf70e2e18f90a56623 (patch)
tree879ffdd3e63eda735f1841d682db98ec9b47df83 /eclass
parentapp-xemacs/xemacs-base: Upstream experimental version bump (diff)
downloademacs-cf86331609a3e82f99313edf70e2e18f90a56623.tar.gz
emacs-cf86331609a3e82f99313edf70e2e18f90a56623.tar.bz2
emacs-cf86331609a3e82f99313edf70e2e18f90a56623.zip
Add proper @CODE tags in comments.
Diffstat (limited to 'eclass')
-rw-r--r--eclass/ChangeLog3
-rw-r--r--eclass/elisp-common.eclass46
2 files changed, 34 insertions, 15 deletions
diff --git a/eclass/ChangeLog b/eclass/ChangeLog
index 9495777..d443777 100644
--- a/eclass/ChangeLog
+++ b/eclass/ChangeLog
@@ -778,6 +778,9 @@
Copyright 2002-2012 Gentoo Foundation
Distributed under the terms of the GNU General Public License v2
+ 04 Sep 2013; Ulrich Müller <ulm@gentoo.org> elisp-common.eclass:
+ Add proper @CODE tags in comments.
+
24 Aug 2012; Ulrich Müller <ulm@gentoo.org> elisp-common.eclass:
Suppress warning for initial installation.
diff --git a/eclass/elisp-common.eclass b/eclass/elisp-common.eclass
index 4decc2c..8085e56 100644
--- a/eclass/elisp-common.eclass
+++ b/eclass/elisp-common.eclass
@@ -23,7 +23,9 @@
#
# When relying on the emacs USE flag, you need to add
#
-# emacs? ( virtual/emacs )
+# @CODE
+# emacs? ( virtual/emacs )
+# @CODE
#
# to your DEPEND/RDEPEND line and use the functions provided here to
# bring the files to the correct locations.
@@ -35,7 +37,9 @@
# tested with function elisp-need-emacs(), which would typically be
# called from pkg_setup(), as in the following example:
#
-# elisp-need-emacs 23 || die "Emacs version too low"
+# @CODE
+# elisp-need-emacs 23 || die "Emacs version too low"
+# @CODE
#
# Please note that such tests should be limited to packages that are
# known to fail with lower Emacs versions; the standard case is to
@@ -50,7 +54,9 @@
# directory is added to the load-path which makes sure that all files
# are loadable.
#
-# elisp-compile *.el
+# @CODE
+# elisp-compile *.el
+# @CODE
#
# Function elisp-make-autoload-file() can be used to generate a file
# with autoload definitions for the lisp functions. It takes the output
@@ -70,16 +76,20 @@
# choose something else, but remember to tell elisp-site-file-install()
# (see below) the change, as it defaults to ${PN}.
#
-# elisp-install ${PN} *.el *.elc
+# @CODE
+# elisp-install ${PN} *.el *.elc
+# @CODE
#
# To let the Emacs support be activated by Emacs on startup, you need
# to provide a site file (shipped in ${FILESDIR}) which contains the
# startup code (have a look in the documentation of your software).
# Normally this would look like this:
#
-# (add-to-list 'load-path "@SITELISP@")
-# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
-# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
+# @CODE
+# (add-to-list 'load-path "@SITELISP@")
+# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
+# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
+# @CODE
#
# If your Emacs support files are installed in a subdirectory of
# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
@@ -108,11 +118,15 @@
# Best practice is to define a SITEFILE variable in the global scope of
# your ebuild (e.g., right after S or RDEPEND):
#
-# SITEFILE="50${PN}-gentoo.el"
+# @CODE
+# SITEFILE="50${PN}-gentoo.el"
+# @CODE
#
# Which is then installed by
#
-# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
+# @CODE
+# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
+# @CODE
#
# in src_install(). Any characters after the "-gentoo" part and before
# the extension will be stripped from the destination file's name.
@@ -126,13 +140,15 @@
# After that you need to recreate the start-up file of Emacs after
# emerging and unmerging by using
#
-# pkg_postinst() {
-# elisp-site-regen
-# }
+# @CODE
+# pkg_postinst() {
+# elisp-site-regen
+# }
#
-# pkg_postrm() {
-# elisp-site-regen
-# }
+# pkg_postrm() {
+# elisp-site-regen
+# }
+# @CODE
#
# When having optional Emacs support, you should prepend "use emacs &&"
# to above calls of elisp-site-regen().