Gentoo Archives: gentoo-dev

From: Ben Kohler <bkohler@g.o>
To: gentoo-dev@l.g.o
Cc: common-lisp@g.o
Subject: [gentoo-dev] [PATCH] common-lisp-3.eclass: fix various @USAGE inconsistencies
Date: Fri, 06 Sep 2019 18:14:44
Message-Id: 199b74d2-e41b-3a82-40fc-26d0018b472a@gentoo.org
1 Some of these functions are missing @USAGE even though they do require
2 arguments. There's also a redundant function name in a few places.
3
4 Signed-off-by: Ben Kohler <bkohler@g.o>
5 ---
6 eclass/common-lisp-3.eclass | 10 ++++++----
7 1 file changed, 6 insertions(+), 4 deletions(-)
8
9 diff --git a/eclass/common-lisp-3.eclass b/eclass/common-lisp-3.eclass
10 index ae229491025..65ad5a58a34 100644
11 --- a/eclass/common-lisp-3.eclass
12 +++ b/eclass/common-lisp-3.eclass
13 @@ -75,6 +75,7 @@ common-lisp-install-one-source() {
14 }
15
16 # @FUNCTION: lisp-file-p
17 +# @USAGE: <file>
18 # @DESCRIPTION:
19 # Returns true if ${1} is lisp source file.
20 lisp-file-p() {
21 @@ -84,6 +85,7 @@ lisp-file-p() {
22 }
23
24 # @FUNCTION: common-lisp-get-fpredicate
25 +# @USAGE: <type>
26 # @DESCRIPTION:
27 # Outputs the corresponding predicate to check files of type ${1}.
28 common-lisp-get-fpredicate() {
29 @@ -98,7 +100,7 @@ common-lisp-get-fpredicate() {
30 }
31
32 # @FUNCTION: common-lisp-install-sources
33 -# @USAGE: common-lisp-install-sources path [<other_paths>...]
34 +# @USAGE: <path> [...]
35 # @DESCRIPTION:
36 # Recursively install lisp sources of type ${2} if ${1} is -t or
37 # Lisp by default. When given a directory, it will be recursively
38 @@ -126,6 +128,7 @@ common-lisp-install-sources() {
39 }
40
41 # @FUNCTION: common-lisp-install-one-asdf
42 +# @USAGE: <file>
43 # @DESCRIPTION:
44 # Installs ${1} asdf file in CLSOURCEROOT/CLPACKAGE and symlinks it in
45 # CLSYSTEMROOT.
46 @@ -140,7 +143,7 @@ common-lisp-install-one-asdf() {
47 }
48
49 # @FUNCTION: common-lisp-install-asdf
50 -# @USAGE: common-lisp-install-asdf path [<other_paths>...]
51 +# @USAGE: <path> [...]
52 # @DESCRIPTION:
53 # Installs all ASDF files and creates symlinks in CLSYSTEMROOT.
54 # When given a directory, it will be recursively scanned for ASDF
55 @@ -167,7 +170,6 @@ common-lisp-3_src_install() {
56 }
57
58 # @FUNCTION: common-lisp-find-lisp-impl
59 -# @USAGE: common-lisp-find-lisp-impl
60 # @DESCRIPTION:
61 # Outputs an installed Common Lisp implementation. Transverses
62 # CLIMPLEMENTATIONS to find it.
63 @@ -179,7 +181,7 @@ common-lisp-find-lisp-impl() {
64 }
65
66 # @FUNCTION: common-lisp-export-impl-args
67 -# @USAGE: common-lisp-export-impl-args <lisp-implementation>
68 +# @USAGE: <lisp-implementation>
69 # @DESCRIPTION:
70 # Export a few variables containing the switches necessary
71 # to make the CL implementation perform basic functions:
72 --
73 2.23.0