Gentoo Archives: gentoo-dev

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-dev@l.g.o
Subject: [gentoo-dev] [PATCH 2/3] elisp-common.eclass: Replace @ROFF in eclass documentation.
Date: Thu, 20 Feb 2020 16:56:10
Message-Id: w6gy2sxxknx.fsf@kph.uni-mainz.de
In Reply to: [gentoo-dev] [PATCH 0/3] *** SUBJECT HERE *** by "Ulrich Müller"
1 Replace all @ROFF tokens by @SUBSECTION, because the former makes
2 conversion to any format other than a man page very difficult.
3
4 Signed-off-by: Ulrich Müller <ulm@g.o>
5 ---
6 eclass/elisp-common.eclass | 14 +++++---------
7 1 file changed, 5 insertions(+), 9 deletions(-)
8
9 diff --git a/eclass/elisp-common.eclass b/eclass/elisp-common.eclass
10 index b5ea21cb22b..6fa2bbea614 100644
11 --- a/eclass/elisp-common.eclass
12 +++ b/eclass/elisp-common.eclass
13 @@ -1,4 +1,4 @@
14 -# Copyright 1999-2019 Gentoo Authors
15 +# Copyright 1999-2020 Gentoo Authors
16 # Distributed under the terms of the GNU General Public License v2
17
18 # @ECLASS: elisp-common.eclass
19 @@ -43,8 +43,7 @@
20 # Please note that this should be done only for packages that are known
21 # to fail with lower Emacs versions.
22 #
23 -# @ROFF .SS
24 -# src_compile() usage:
25 +# @SUBSECTION src_compile() usage:
26 #
27 # An elisp file is compiled by the elisp-compile() function defined
28 # here and simply takes the source files as arguments. The case of
29 @@ -64,8 +63,7 @@
30 # comments. See the Emacs Lisp Reference Manual (node "Autoload") for
31 # a detailed explanation.
32 #
33 -# @ROFF .SS
34 -# src_install() usage:
35 +# @SUBSECTION src_install() usage:
36 #
37 # The resulting compiled files (.elc) should be put in a subdirectory of
38 # /usr/share/emacs/site-lisp/ which is named after the first argument
39 @@ -132,8 +130,7 @@
40 # "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
41 # the differing name as second argument.
42 #
43 -# @ROFF .SS
44 -# pkg_setup() usage:
45 +# @SUBSECTION pkg_setup() usage:
46 #
47 # If your ebuild uses the elisp-compile eclass function to compile
48 # its elisp files (see above), then you don't need a pkg_setup phase,
49 @@ -149,8 +146,7 @@
50 # When having optional Emacs support, you should prepend "use emacs &&"
51 # to above call of elisp-check-emacs-version().
52 #
53 -# @ROFF .SS
54 -# pkg_postinst() / pkg_postrm() usage:
55 +# @SUBSECTION pkg_postinst() / pkg_postrm() usage:
56 #
57 # After that you need to recreate the start-up file of Emacs after
58 # emerging and unmerging by using
59 --
60 2.25.1

Attachments

File name MIME type
signature.asc application/pgp-signature