1 |
commit: 2f653f03c381cd6c4b1c7fc3aa7b25901fc8b47f |
2 |
Author: Michał Górny <mgorny <AT> gentoo <DOT> org> |
3 |
AuthorDate: Mon Dec 28 09:12:24 2020 +0000 |
4 |
Commit: Michał Górny <mgorny <AT> gentoo <DOT> org> |
5 |
CommitDate: Mon Dec 28 09:31:30 2020 +0000 |
6 |
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=2f653f03 |
7 |
|
8 |
eclass: [QA] Revert multiple meaningless doc changes |
9 |
|
10 |
Revert multiple meaningless eclass documentation changes, notably adding |
11 |
a lot of placeholders and documenting implementation details. These |
12 |
changes were aimed at silencing (valid) documentation warnings without |
13 |
actually providing valuable documentation to the end users. While some |
14 |
of these changes were beneficial, it would take a lot of effort to |
15 |
review them all and the author is unwilling to fix his mistakes. |
16 |
|
17 |
Signed-off-by: Michał Górny <mgorny <AT> gentoo.org> |
18 |
|
19 |
eclass/acct-group.eclass | 5 -- |
20 |
eclass/acct-user.eclass | 5 -- |
21 |
eclass/alternatives.eclass | 11 +--- |
22 |
eclass/ant-tasks.eclass | 3 +- |
23 |
eclass/apache-2.eclass | 7 +-- |
24 |
eclass/apache-module.eclass | 12 ----- |
25 |
eclass/aspell-dict-r1.eclass | 5 -- |
26 |
eclass/autotools-utils.eclass | 11 ---- |
27 |
eclass/autotools.eclass | 110 +++----------------------------------- |
28 |
eclass/base.eclass | 10 ---- |
29 |
eclass/bash-completion-r1.eclass | 5 +- |
30 |
eclass/bazel.eclass | 5 -- |
31 |
eclass/cargo.eclass | 17 ------ |
32 |
eclass/cdrom.eclass | 5 -- |
33 |
eclass/check-reqs.eclass | 9 +--- |
34 |
eclass/chromium-2.eclass | 9 ---- |
35 |
eclass/cmake.eclass | 12 ----- |
36 |
eclass/cuda.eclass | 5 -- |
37 |
eclass/cvs.eclass | 12 +---- |
38 |
eclass/db-use.eclass | 34 +++--------- |
39 |
eclass/db.eclass | 26 +-------- |
40 |
eclass/depend.apache.eclass | 15 ------ |
41 |
eclass/desktop.eclass | 5 -- |
42 |
eclass/distutils-r1.eclass | 37 ------------- |
43 |
eclass/docs.eclass | 8 +-- |
44 |
eclass/dotnet.eclass | 3 +- |
45 |
eclass/ecm.eclass | 5 -- |
46 |
eclass/elisp-common.eclass | 2 - |
47 |
eclass/emboss-r2.eclass | 5 -- |
48 |
eclass/epatch.eclass | 5 -- |
49 |
eclass/estack.eclass | 7 +-- |
50 |
eclass/eutils.eclass | 9 ---- |
51 |
eclass/fcaps.eclass | 5 -- |
52 |
eclass/findlib.eclass | 6 +-- |
53 |
eclass/fixheadtails.eclass | 5 -- |
54 |
eclass/flag-o-matic.eclass | 36 ------------- |
55 |
eclass/font-ebdftopcf.eclass | 25 ++++----- |
56 |
eclass/font.eclass | 5 -- |
57 |
eclass/fortran-2.eclass | 10 ---- |
58 |
eclass/games.eclass | 4 -- |
59 |
eclass/gnuconfig.eclass | 19 ++----- |
60 |
eclass/golang-vcs-snapshot.eclass | 9 ++-- |
61 |
eclass/java-utils-2.eclass | 13 ++--- |
62 |
eclass/mozextension.eclass | 19 +------ |
63 |
eclass/myspell-r2.eclass | 1 + |
64 |
eclass/openib.eclass | 4 +- |
65 |
eclass/php-pear-r2.eclass | 5 +- |
66 |
eclass/portability.eclass | 2 + |
67 |
eclass/postgres-multi.eclass | 3 +- |
68 |
eclass/postgres.eclass | 3 +- |
69 |
eclass/rebar.eclass | 4 +- |
70 |
eclass/ruby-ng.eclass | 1 - |
71 |
eclass/ssl-cert.eclass | 3 +- |
72 |
eclass/stardict.eclass | 13 ++--- |
73 |
eclass/toolchain.eclass | 8 +-- |
74 |
eclass/vim-doc.eclass | 7 +-- |
75 |
56 files changed, 71 insertions(+), 558 deletions(-) |
76 |
|
77 |
diff --git a/eclass/acct-group.eclass b/eclass/acct-group.eclass |
78 |
index 18a40d7ad6f..1d5d14290da 100644 |
79 |
--- a/eclass/acct-group.eclass |
80 |
+++ b/eclass/acct-group.eclass |
81 |
@@ -31,11 +31,6 @@ |
82 |
# - RDEPEND if it is needed at install time (e.g. you 'fowners' files |
83 |
# in pkg_preinst) or run time. |
84 |
|
85 |
-# @VARIABLE: _ACCT_GROUP_ECLASS |
86 |
-# @INTERNAL |
87 |
-# @DESCRIPTION: |
88 |
-# If null set to 1 |
89 |
- |
90 |
if [[ -z ${_ACCT_GROUP_ECLASS} ]]; then |
91 |
_ACCT_GROUP_ECLASS=1 |
92 |
|
93 |
|
94 |
diff --git a/eclass/acct-user.eclass b/eclass/acct-user.eclass |
95 |
index af5a4a92335..22b0038fbff 100644 |
96 |
--- a/eclass/acct-user.eclass |
97 |
+++ b/eclass/acct-user.eclass |
98 |
@@ -39,11 +39,6 @@ |
99 |
# - RDEPEND if it is needed at install time (e.g. you 'fowners' files |
100 |
# in pkg_preinst) or run time. |
101 |
|
102 |
-# @VARIABLE: _ACCT_USER_ECLASS |
103 |
-# @INTERNAL |
104 |
-# @DESCRIPTION: |
105 |
-# If null set to 1 |
106 |
- |
107 |
if [[ -z ${_ACCT_USER_ECLASS} ]]; then |
108 |
_ACCT_USER_ECLASS=1 |
109 |
|
110 |
|
111 |
diff --git a/eclass/alternatives.eclass b/eclass/alternatives.eclass |
112 |
index 108a55af811..79f14d81b13 100644 |
113 |
--- a/eclass/alternatives.eclass |
114 |
+++ b/eclass/alternatives.eclass |
115 |
@@ -2,8 +2,6 @@ |
116 |
# Distributed under the terms of the GNU General Public License v2 |
117 |
|
118 |
# @ECLASS: alternatives.eclass |
119 |
-# @MAINTAINER: |
120 |
-# maintainer-needed@g.o |
121 |
# @AUTHOR: |
122 |
# Original author: Alastair Tse <liquidx@g.o> (03 Oct 2003) |
123 |
# @BLURB: Creates symlink to the latest version of multiple slotted packages. |
124 |
@@ -74,17 +72,14 @@ alternatives_auto_makesym() { |
125 |
alternatives_makesym ${SYMLINK} ${ALT} |
126 |
} |
127 |
|
128 |
-# @FUNCTION: alternatives_makesym |
129 |
-# @USAGE: alternatives_makesym <resulting symlink> [alternative targets..] |
130 |
-# @DESCRIPTION: |
131 |
-# make sure it is in the prefix, allow it already to be in the prefix |
132 |
- |
133 |
alternatives_makesym() { |
134 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX= |
135 |
local ALTERNATIVES="" |
136 |
local SYMLINK="" |
137 |
local alt pref |
138 |
|
139 |
+ # usage: alternatives_makesym <resulting symlink> [alternative targets..] |
140 |
+ # make sure it is in the prefix, allow it already to be in the prefix |
141 |
SYMLINK=${EPREFIX}/${1#${EPREFIX}} |
142 |
# this trick removes the trailing / from ${ROOT} |
143 |
pref=${ROOT%/} |
144 |
@@ -129,7 +124,6 @@ alternatives_makesym() { |
145 |
# @FUNCTION: alernatives-pkg_postinst |
146 |
# @DESCRIPTION: |
147 |
# The alternatives pkg_postinst, this function will be exported |
148 |
- |
149 |
alternatives_pkg_postinst() { |
150 |
if [ -n "${ALTERNATIVES}" -a -n "${SOURCE}" ]; then |
151 |
alternatives_makesym ${SOURCE} ${ALTERNATIVES} |
152 |
@@ -139,7 +133,6 @@ alternatives_pkg_postinst() { |
153 |
# @FUNCTION: alternatives_pkg_postrm |
154 |
# @DESCRIPTION: |
155 |
# The alternatives pkg_postrm, this function will be exported |
156 |
- |
157 |
alternatives_pkg_postrm() { |
158 |
if [ -n "${ALTERNATIVES}" -a -n "${SOURCE}" ]; then |
159 |
alternatives_makesym ${SOURCE} ${ALTERNATIVES} |
160 |
|
161 |
diff --git a/eclass/ant-tasks.eclass b/eclass/ant-tasks.eclass |
162 |
index a96222f8ff5..42f801a84d7 100644 |
163 |
--- a/eclass/ant-tasks.eclass |
164 |
+++ b/eclass/ant-tasks.eclass |
165 |
@@ -1,4 +1,4 @@ |
166 |
-# Copyright 2007-2019 Gentoo Authors |
167 |
+# Copyright 2007-2020 Gentoo Authors |
168 |
# Distributed under the terms of the GNU General Public License v2 |
169 |
|
170 |
# @ECLASS: ant-tasks.eclass |
171 |
@@ -66,7 +66,6 @@ ANT_TASK_DEPNAME=${ANT_TASK_DEPNAME-${ANT_TASK_NAME}} |
172 |
|
173 |
# @VARIABLE: ANT_TASK_PV |
174 |
# @INTERNAL |
175 |
-# @DESCRIPTION: |
176 |
# Version of ant-core this task is intended to register and thus load with. |
177 |
ANT_TASK_PV="${PV}" |
178 |
|
179 |
|
180 |
diff --git a/eclass/apache-2.eclass b/eclass/apache-2.eclass |
181 |
index ded2b6696aa..ccfe482f528 100644 |
182 |
--- a/eclass/apache-2.eclass |
183 |
+++ b/eclass/apache-2.eclass |
184 |
@@ -1,4 +1,4 @@ |
185 |
-# Copyright 1999-2019 Gentoo Authors |
186 |
+# Copyright 1999-2020 Gentoo Authors |
187 |
# Distributed under the terms of the GNU General Public License v2 |
188 |
|
189 |
# @ECLASS: apache-2.eclass |
190 |
@@ -87,12 +87,7 @@ SRC_URI="mirror://apache/httpd/httpd-${PV}.tar.bz2 |
191 |
# This variable needs to be set in the ebuild and contains a list of available |
192 |
# built-in modules |
193 |
|
194 |
-# @VARIABLE: IUSE_MPMS |
195 |
-# @DESCRIPTION: |
196 |
-# Combine IUSE_MPMS_FORK and IUSE_MPMS_THREAD |
197 |
- |
198 |
IUSE_MPMS="${IUSE_MPMS_FORK} ${IUSE_MPMS_THREAD}" |
199 |
- |
200 |
IUSE="${IUSE} debug doc gdbm ldap libressl selinux ssl static suexec threads" |
201 |
|
202 |
for module in ${IUSE_MODULES} ; do |
203 |
|
204 |
diff --git a/eclass/apache-module.eclass b/eclass/apache-module.eclass |
205 |
index 05372bcd426..e192a745427 100644 |
206 |
--- a/eclass/apache-module.eclass |
207 |
+++ b/eclass/apache-module.eclass |
208 |
@@ -95,11 +95,7 @@ inherit depend.apache |
209 |
# INTERNAL FUNCTIONS |
210 |
# ============================================================================== |
211 |
|
212 |
-# @FUNCTION: apache_cd_dir |
213 |
-# @INTERNAL |
214 |
-# @DESCRIPTION: |
215 |
# Internal function to construct the default ${APXS2_S} path if required. |
216 |
- |
217 |
apache_cd_dir() { |
218 |
debug-print-function $FUNCNAME $* |
219 |
|
220 |
@@ -117,11 +113,7 @@ apache_cd_dir() { |
221 |
echo "${CD_DIR}" |
222 |
} |
223 |
|
224 |
-# @FUNCTION: apache_mod_file |
225 |
-# @INTERNAL |
226 |
-# @DESCRIPTION: |
227 |
# Internal function to construct the default ${APACHE2_MOD_FILE} if required. |
228 |
- |
229 |
apache_mod_file() { |
230 |
debug-print-function $FUNCNAME $* |
231 |
|
232 |
@@ -131,13 +123,9 @@ apache_mod_file() { |
233 |
echo "${MOD_FILE}" |
234 |
} |
235 |
|
236 |
-# @FUNCTION: apache_doc_magic |
237 |
-# @INTERNAL |
238 |
-# @DESCRIPTION: |
239 |
# Internal function for picking out html files from ${DOCFILES}. It takes an |
240 |
# optional first argument `html'; if the first argument is equals `html', only |
241 |
# html files are returned, otherwise normal (non-html) docs are returned. |
242 |
- |
243 |
apache_doc_magic() { |
244 |
debug-print-function $FUNCNAME $* |
245 |
|
246 |
|
247 |
diff --git a/eclass/aspell-dict-r1.eclass b/eclass/aspell-dict-r1.eclass |
248 |
index 14e2b0b6344..b07af61fdf1 100644 |
249 |
--- a/eclass/aspell-dict-r1.eclass |
250 |
+++ b/eclass/aspell-dict-r1.eclass |
251 |
@@ -42,11 +42,6 @@ esac |
252 |
|
253 |
EXPORT_FUNCTIONS src_configure src_install |
254 |
|
255 |
-# @VARIABLE: _ASPELL_DICT_R1 |
256 |
-# @INTERNAL |
257 |
-# @DESCRIPTION: |
258 |
-# Please document me |
259 |
- |
260 |
if [[ ! ${_ASPELL_DICT_R1} ]]; then |
261 |
|
262 |
# aspell packages have an idiosyncratic versioning scheme, that is |
263 |
|
264 |
diff --git a/eclass/autotools-utils.eclass b/eclass/autotools-utils.eclass |
265 |
index 13d2f653a97..3fcaa79f80a 100644 |
266 |
--- a/eclass/autotools-utils.eclass |
267 |
+++ b/eclass/autotools-utils.eclass |
268 |
@@ -113,11 +113,6 @@ esac |
269 |
# Note that dependencies are added for autoconf, automake and libtool only. |
270 |
# If your package needs one of the external tools listed above, you need to add |
271 |
# appropriate packages to DEPEND yourself. |
272 |
- |
273 |
-# @VARIABLE: AUTOTOOLS_AUTO_DEPEND |
274 |
-# @DESCRIPTION: |
275 |
-# Please document me |
276 |
- |
277 |
[[ ${AUTOTOOLS_AUTORECONF} ]] || : ${AUTOTOOLS_AUTO_DEPEND:=no} |
278 |
|
279 |
# eutils for eqawarn, path_exists |
280 |
@@ -197,12 +192,6 @@ EXPORT_FUNCTIONS src_prepare src_configure src_compile src_install src_test |
281 |
# cases only. |
282 |
|
283 |
# Determine using IN or OUT source build |
284 |
- |
285 |
-# @FUNCTION: _check_build_dir |
286 |
-# @INTERNAL |
287 |
-# @DESCRIPTION: |
288 |
-# Please document me |
289 |
- |
290 |
_check_build_dir() { |
291 |
: ${ECONF_SOURCE:=${S}} |
292 |
# Respect both the old variable and the new one, depending |
293 |
|
294 |
diff --git a/eclass/autotools.eclass b/eclass/autotools.eclass |
295 |
index 12c8e899d19..d7ce23bfdf3 100644 |
296 |
--- a/eclass/autotools.eclass |
297 |
+++ b/eclass/autotools.eclass |
298 |
@@ -23,11 +23,6 @@ if [[ ${__AUTOTOOLS_AUTO_DEPEND+set} == "set" ]] ; then |
299 |
fi |
300 |
fi |
301 |
|
302 |
-# @ECLASS-VARIABLE: _AUTOTOOLS_ECLASS |
303 |
-# @INTERNAL |
304 |
-# @DESCRIPTION: |
305 |
-# Please document |
306 |
- |
307 |
if [[ -z ${_AUTOTOOLS_ECLASS} ]]; then |
308 |
_AUTOTOOLS_ECLASS=1 |
309 |
|
310 |
@@ -104,11 +99,6 @@ if [[ -n ${WANT_AUTOCONF} ]] ; then |
311 |
export WANT_AUTOCONF |
312 |
fi |
313 |
|
314 |
-# @ECLASS-VARIABLE: _libtool_atom |
315 |
-# @INTERNAL |
316 |
-# @DESCRIPTION: |
317 |
-# Set libtool ${P} |
318 |
- |
319 |
_libtool_atom=">=sys-devel/libtool-2.4" |
320 |
if [[ -n ${WANT_LIBTOOL} ]] ; then |
321 |
case ${WANT_LIBTOOL} in |
322 |
@@ -119,10 +109,6 @@ if [[ -n ${WANT_LIBTOOL} ]] ; then |
323 |
export WANT_LIBTOOL |
324 |
fi |
325 |
|
326 |
-# @ECLASS-VARIABLE: AUTOTOOLS_DEPEND |
327 |
-# @DESCRIPTION: |
328 |
-# Set DEPEND |
329 |
- |
330 |
AUTOTOOLS_DEPEND="${_automake_atom} |
331 |
${_autoconf_atom} |
332 |
${_libtool_atom}" |
333 |
@@ -133,7 +119,6 @@ RDEPEND="" |
334 |
# Set to 'no' to disable automatically adding to DEPEND. This lets |
335 |
# ebuilds form conditional depends by using ${AUTOTOOLS_DEPEND} in |
336 |
# their own DEPEND string. |
337 |
- |
338 |
: ${AUTOTOOLS_AUTO_DEPEND:=yes} |
339 |
if [[ ${AUTOTOOLS_AUTO_DEPEND} != "no" ]] ; then |
340 |
case ${EAPI:-0} in |
341 |
@@ -141,12 +126,6 @@ if [[ ${AUTOTOOLS_AUTO_DEPEND} != "no" ]] ; then |
342 |
7) BDEPEND=${AUTOTOOLS_DEPEND} ;; |
343 |
esac |
344 |
fi |
345 |
- |
346 |
-# @ECLASS-VARIABLE: __AUTOTOOLS_AUTO_DEPEND |
347 |
-# @INTERNAL |
348 |
-# @DESCRIPTION: |
349 |
-# Set internal variable |
350 |
- |
351 |
__AUTOTOOLS_AUTO_DEPEND=${AUTOTOOLS_AUTO_DEPEND} # See top of eclass |
352 |
|
353 |
unset _automake_atom _autoconf_atom |
354 |
@@ -272,7 +251,6 @@ eautoreconf() { |
355 |
# @FUNCTION: _at_uses_pkg |
356 |
# @USAGE: <macros> |
357 |
# @INTERNAL |
358 |
-# @DESCRIPTION: |
359 |
# See if the specified macros are enabled. |
360 |
_at_uses_pkg() { |
361 |
if [[ -n $(autotools_check_macro "$@") ]] ; then |
362 |
@@ -287,68 +265,14 @@ _at_uses_pkg() { |
363 |
egrep -q "${args[@]}" configure.?? |
364 |
fi |
365 |
} |
366 |
- |
367 |
-# @FUNCTION: _at_uses_autoheader |
368 |
-# @INTERNAL |
369 |
-# @DESCRIPTION: |
370 |
-# Call another function |
371 |
- |
372 |
_at_uses_autoheader() { _at_uses_pkg A{C,M}_CONFIG_HEADER{S,}; } |
373 |
- |
374 |
-# @FUNCTION: _at_uses_automake |
375 |
-# @INTERNAL |
376 |
-# @DESCRIPTION: |
377 |
-# Call another function |
378 |
- |
379 |
_at_uses_automake() { _at_uses_pkg AM_INIT_AUTOMAKE; } |
380 |
- |
381 |
-# @FUNCTION: _at_uses_gettext |
382 |
-# @INTERNAL |
383 |
-# @DESCRIPTION: |
384 |
-# Call another function |
385 |
- |
386 |
_at_uses_gettext() { _at_uses_pkg AM_GNU_GETTEXT_{,REQUIRE_}VERSION; } |
387 |
- |
388 |
-# @FUNCTION: _at_uses_glibgettext |
389 |
-# @INTERNAL |
390 |
-# @DESCRIPTION: |
391 |
-# Call another function |
392 |
- |
393 |
_at_uses_glibgettext() { _at_uses_pkg AM_GLIB_GNU_GETTEXT; } |
394 |
- |
395 |
-# @FUNCTION: _at_uses_intltool |
396 |
-# @INTERNAL |
397 |
-# @DESCRIPTION: |
398 |
-# Call another function |
399 |
- |
400 |
_at_uses_intltool() { _at_uses_pkg {AC,IT}_PROG_INTLTOOL; } |
401 |
- |
402 |
-# @FUNCTION: _at_uses_gtkdoc |
403 |
-# @INTERNAL |
404 |
-# @DESCRIPTION: |
405 |
-# Call another function |
406 |
- |
407 |
_at_uses_gtkdoc() { _at_uses_pkg GTK_DOC_CHECK; } |
408 |
- |
409 |
-# @FUNCTION: _at_uses_gnomedoc |
410 |
-# @INTERNAL |
411 |
-# @DESCRIPTION: |
412 |
-# Call another function |
413 |
- |
414 |
_at_uses_gnomedoc() { _at_uses_pkg GNOME_DOC_INIT; } |
415 |
- |
416 |
-# @FUNCTION: _at_uses_libtool |
417 |
-# @INTERNAL |
418 |
-# @DESCRIPTION: |
419 |
-# Call another function |
420 |
- |
421 |
_at_uses_libtool() { _at_uses_pkg A{C,M}_PROG_LIBTOOL LT_INIT; } |
422 |
- |
423 |
-# @FUNCTION: _at_uses_libltdl |
424 |
-# @INTERNAL |
425 |
-# @DESCRIPTION: |
426 |
-# Call another function |
427 |
- |
428 |
_at_uses_libltdl() { _at_uses_pkg LT_CONFIG_LTDL_DIR; } |
429 |
|
430 |
# @FUNCTION: eaclocal_amflags |
431 |
@@ -367,10 +291,10 @@ eaclocal_amflags() { |
432 |
autotools_env_setup |
433 |
aclocal_opts=$(sed -n \ |
434 |
"/^ACLOCAL_AMFLAGS[[:space:]]*=/{ \ |
435 |
- # match the first line |
436 |
- s:[^=]*=::p; \ |
437 |
- # then gobble up all escaped lines |
438 |
- : nextline /\\\\$/{ n; p; b nextline; } \ |
439 |
+ # match the first line |
440 |
+ s:[^=]*=::p; \ |
441 |
+ # then gobble up all escaped lines |
442 |
+ : nextline /\\\\$/{ n; p; b nextline; } \ |
443 |
}" ${amflags_file}) |
444 |
eval aclocal_opts=\""${aclocal_opts}"\" |
445 |
break |
446 |
@@ -626,11 +550,10 @@ autotools_run_tool() { |
447 |
fi |
448 |
} |
449 |
|
450 |
-# @ECLASS-VARIABLE: ALL_AUTOTOOLS_MACROS |
451 |
-# @DESCRIPTION: |
452 |
+# Internal function to check for support |
453 |
+ |
454 |
# Keep a list of all the macros we might use so that we only |
455 |
# have to run the trace code once. Order doesn't matter. |
456 |
- |
457 |
ALL_AUTOTOOLS_MACROS=( |
458 |
A{C,M}_PROG_LIBTOOL LT_INIT LT_CONFIG_LTDL_DIR |
459 |
A{C,M}_CONFIG_HEADER{S,} |
460 |
@@ -643,11 +566,6 @@ ALL_AUTOTOOLS_MACROS=( |
461 |
GTK_DOC_CHECK |
462 |
GNOME_DOC_INIT |
463 |
) |
464 |
- |
465 |
-# @FUNCTION: autotools_check_macro |
466 |
-# @DESCRIPTION: |
467 |
-# Check the macros |
468 |
- |
469 |
autotools_check_macro() { |
470 |
[[ -f configure.ac || -f configure.in ]] || return 0 |
471 |
|
472 |
@@ -673,7 +591,6 @@ autotools_check_macro() { |
473 |
# @INTERNAL |
474 |
# @DESCRIPTION: |
475 |
# Look for a macro and extract its value. |
476 |
- |
477 |
autotools_check_macro_val() { |
478 |
local macro scan_out |
479 |
|
480 |
@@ -689,11 +606,6 @@ autotools_check_macro_val() { |
481 |
return 0 |
482 |
} |
483 |
|
484 |
-# @FUNCTION: _autotools_m4dir_include |
485 |
-# @INTERNAL |
486 |
-# @DESCRIPTION: |
487 |
-# m4dir include stuff |
488 |
- |
489 |
_autotools_m4dir_include() { |
490 |
local x include_opts flag |
491 |
|
492 |
@@ -715,17 +627,7 @@ _autotools_m4dir_include() { |
493 |
|
494 |
echo ${include_opts} |
495 |
} |
496 |
- |
497 |
-# @FUNCTION: autotools_m4dir_include |
498 |
-# @DESCRIPTION: |
499 |
-# Call another function |
500 |
- |
501 |
autotools_m4dir_include() { _autotools_m4dir_include ${AT_M4DIR} ; } |
502 |
- |
503 |
-# @FUNCTION: autotools_m4sysdir_include |
504 |
-# @DESCRIPTION: |
505 |
-# m4sysdir include stuff |
506 |
- |
507 |
autotools_m4sysdir_include() { |
508 |
# First try to use the paths the system integrator has set up. |
509 |
local paths=( $(eval echo ${AT_SYS_M4DIR}) ) |
510 |
|
511 |
diff --git a/eclass/base.eclass b/eclass/base.eclass |
512 |
index 4682890b3dc..0f9a2e576b7 100644 |
513 |
--- a/eclass/base.eclass |
514 |
+++ b/eclass/base.eclass |
515 |
@@ -28,22 +28,12 @@ |
516 |
# @DESCRIPTION: |
517 |
# The base eclass defines some default functions and variables. |
518 |
|
519 |
-# @VARIABLE: _BASE_ECLASS |
520 |
-# @INTERNAL |
521 |
-# @DESCRIPTION: |
522 |
-# If null set to 1 |
523 |
- |
524 |
if [[ -z ${_BASE_ECLASS} ]]; then |
525 |
_BASE_ECLASS=1 |
526 |
|
527 |
inherit eutils |
528 |
|
529 |
-# @VARIABLE: BASE_EXPF |
530 |
-# @DESCRIPTION: |
531 |
-# Please document me |
532 |
- |
533 |
BASE_EXPF="src_unpack src_compile src_install" |
534 |
- |
535 |
case "${EAPI:-0}" in |
536 |
0|1) ;; |
537 |
2|3|4|5) BASE_EXPF+=" src_prepare src_configure" ;; |
538 |
|
539 |
diff --git a/eclass/bash-completion-r1.eclass b/eclass/bash-completion-r1.eclass |
540 |
index b5c7d2854f7..70d40a25969 100644 |
541 |
--- a/eclass/bash-completion-r1.eclass |
542 |
+++ b/eclass/bash-completion-r1.eclass |
543 |
@@ -1,4 +1,4 @@ |
544 |
-# Copyright 1999-2019 Gentoo Authors |
545 |
+# Copyright 1999-2020 Gentoo Authors |
546 |
# Distributed under the terms of the GNU General Public License v2 |
547 |
|
548 |
# @ECLASS: bash-completion-r1.eclass |
549 |
@@ -61,11 +61,10 @@ _bash-completion-r1_get_bashcompdir() { |
550 |
_bash-completion-r1_get_bashdir completionsdir /usr/share/bash-completion/completions |
551 |
} |
552 |
|
553 |
-# @FUNCTION: _bash-completion-r1_get_bashhelpersdir |
554 |
+# @FUNCTION: _bash-completion-r1_get_helpersdir |
555 |
# @INTERNAL |
556 |
# @DESCRIPTION: |
557 |
# Get unprefixed bash-completion helpers directory. |
558 |
- |
559 |
_bash-completion-r1_get_bashhelpersdir() { |
560 |
debug-print-function ${FUNCNAME} "${@}" |
561 |
|
562 |
|
563 |
diff --git a/eclass/bazel.eclass b/eclass/bazel.eclass |
564 |
index 493e2d4593d..854b740db4f 100644 |
565 |
--- a/eclass/bazel.eclass |
566 |
+++ b/eclass/bazel.eclass |
567 |
@@ -24,11 +24,6 @@ case "${EAPI:-0}" in |
568 |
;; |
569 |
esac |
570 |
|
571 |
-# @VARIABLE: _BAZEL_ECLASS |
572 |
-# @INTERNAL |
573 |
-# @DESCRIPTION: |
574 |
-# Please document me |
575 |
- |
576 |
if [[ ! ${_BAZEL_ECLASS} ]]; then |
577 |
|
578 |
inherit multiprocessing toolchain-funcs |
579 |
|
580 |
diff --git a/eclass/cargo.eclass b/eclass/cargo.eclass |
581 |
index d1e968b4e9c..7f7a681f6f5 100644 |
582 |
--- a/eclass/cargo.eclass |
583 |
+++ b/eclass/cargo.eclass |
584 |
@@ -9,18 +9,10 @@ |
585 |
# @SUPPORTED_EAPIS: 6 7 |
586 |
# @BLURB: common functions and variables for cargo builds |
587 |
|
588 |
-# @VARIABLE: _CARGO_ECLASS |
589 |
-# @INTERNAL |
590 |
-# @DESCRIPTION: |
591 |
-# If null set to 1 |
592 |
- |
593 |
if [[ -z ${_CARGO_ECLASS} ]]; then |
594 |
_CARGO_ECLASS=1 |
595 |
|
596 |
-# @VARIABLE: RUST_DEPEND |
597 |
-# @DESCRIPTION: |
598 |
# we need this for 'cargo vendor' subcommand and net.offline config knob |
599 |
- |
600 |
RUST_DEPEND=">=virtual/rust-1.37.0" |
601 |
|
602 |
case "${EAPI:-0}" in |
603 |
@@ -43,16 +35,7 @@ fi |
604 |
|
605 |
IUSE="${IUSE} debug" |
606 |
|
607 |
-# @VARIABLE: ECARGO_HOME |
608 |
-# @DESCRIPTION: |
609 |
-# Adjust the working directory |
610 |
- |
611 |
ECARGO_HOME="${WORKDIR}/cargo_home" |
612 |
- |
613 |
-# @VARIABLE: ECARGO_VENDOR |
614 |
-# @DESCRIPTION: |
615 |
-# Vendorize the working directory |
616 |
- |
617 |
ECARGO_VENDOR="${ECARGO_HOME}/gentoo" |
618 |
|
619 |
# @ECLASS-VARIABLE: CARGO_OPTIONAL |
620 |
|
621 |
diff --git a/eclass/cdrom.eclass b/eclass/cdrom.eclass |
622 |
index 4481eaa1dd9..4bbe6aa3175 100644 |
623 |
--- a/eclass/cdrom.eclass |
624 |
+++ b/eclass/cdrom.eclass |
625 |
@@ -14,11 +14,6 @@ |
626 |
# eclass will require RESTRICT="bindist" but the point still stands. |
627 |
# The functions are generally called in src_unpack. |
628 |
|
629 |
-# @VARIABLE: _CDROM_ECLASS |
630 |
-# @INTERNAL |
631 |
-# @DESCRIPTION: |
632 |
-# If null set to 1 |
633 |
- |
634 |
if [[ -z ${_CDROM_ECLASS} ]]; then |
635 |
_CDROM_ECLASS=1 |
636 |
|
637 |
|
638 |
diff --git a/eclass/check-reqs.eclass b/eclass/check-reqs.eclass |
639 |
index e512c1bb23a..a45cbd15fee 100644 |
640 |
--- a/eclass/check-reqs.eclass |
641 |
+++ b/eclass/check-reqs.eclass |
642 |
@@ -38,11 +38,6 @@ |
643 |
# These checks should probably mostly work on non-Linux, and they should |
644 |
# probably degrade gracefully if they don't. Probably. |
645 |
|
646 |
-# @VARIABLE: _CHECK_REQS_ECLASS_ |
647 |
-# @INTERNAL |
648 |
-# @DESCRIPTION: |
649 |
-# Please document me |
650 |
- |
651 |
if [[ ! ${_CHECK_REQS_ECLASS_} ]]; then |
652 |
|
653 |
# @ECLASS-VARIABLE: CHECKREQS_MEMORY |
654 |
@@ -72,8 +67,6 @@ esac |
655 |
|
656 |
EXPORT_FUNCTIONS pkg_pretend pkg_setup |
657 |
|
658 |
-# @FUNCTION: check_reqs |
659 |
-# @DESCRIPTION: |
660 |
# Obsolete function executing all the checks and printing out results |
661 |
check_reqs() { |
662 |
eerror "Package calling old ${FUNCNAME} function." |
663 |
@@ -357,8 +350,8 @@ check-reqs_unsatisfied() { |
664 |
${msg} "There is NOT at least ${sizeunit} ${location}" |
665 |
|
666 |
# @ECLASS-VARIABLE: CHECKREQS_FAILED |
667 |
- # @INTERNAL |
668 |
# @DESCRIPTION: |
669 |
+ # @INTERNAL |
670 |
# If set the checks failed and eclass should abort the build. |
671 |
# Internal, do not set yourself. |
672 |
CHECKREQS_FAILED="true" |
673 |
|
674 |
diff --git a/eclass/chromium-2.eclass b/eclass/chromium-2.eclass |
675 |
index d8225f983e2..b3d63f302d0 100644 |
676 |
--- a/eclass/chromium-2.eclass |
677 |
+++ b/eclass/chromium-2.eclass |
678 |
@@ -43,11 +43,6 @@ chromium_suid_sandbox_check_kernel_config() { |
679 |
# @DESCRIPTION: |
680 |
# List of language packs available for this package. |
681 |
|
682 |
-# @FUNCTION: _chromium_set_l10n_IUSE |
683 |
-# @INTERNAL |
684 |
-# @DESCRIPTION: |
685 |
-# Please document me |
686 |
- |
687 |
_chromium_set_l10n_IUSE() { |
688 |
[[ ${EAPI:-0} == 0 ]] && die "EAPI=${EAPI} is not supported" |
689 |
|
690 |
@@ -105,10 +100,6 @@ chromium_remove_language_paks() { |
691 |
done |
692 |
} |
693 |
|
694 |
-# @FUNCTION: chromium_pkg_die |
695 |
-# @DESCRIPTION: |
696 |
-# Various reasons to die |
697 |
- |
698 |
chromium_pkg_die() { |
699 |
if [[ "${EBUILD_PHASE}" != "compile" ]]; then |
700 |
return |
701 |
|
702 |
diff --git a/eclass/cmake.eclass b/eclass/cmake.eclass |
703 |
index 384556fd7d1..62fa0271570 100644 |
704 |
--- a/eclass/cmake.eclass |
705 |
+++ b/eclass/cmake.eclass |
706 |
@@ -17,11 +17,6 @@ |
707 |
# out-of-source builds (default), in-source builds and an implementation of the |
708 |
# well-known use_enable function for CMake. |
709 |
|
710 |
-# @VARIABLE: _CMAKE_ECLASS |
711 |
-# @INTERNAL |
712 |
-# @DESCRIPTION: |
713 |
-# If null set to 1 |
714 |
- |
715 |
if [[ -z ${_CMAKE_ECLASS} ]]; then |
716 |
_CMAKE_ECLASS=1 |
717 |
|
718 |
@@ -140,10 +135,7 @@ _cmake_banned_func() { |
719 |
die "${FUNCNAME[1]} is banned. use -D$1<related_CMake_variable>=\"\$(usex $2)\" instead" |
720 |
} |
721 |
|
722 |
-# @FUNCTION: _cmake_check_build_dir |
723 |
-# @DESCRIPTION: |
724 |
# Determine using IN or OUT source build |
725 |
- |
726 |
_cmake_check_build_dir() { |
727 |
: ${CMAKE_USE_DIR:=${S}} |
728 |
if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then |
729 |
@@ -276,12 +268,8 @@ cmake-utils_use() { _cmake_banned_func "" "$@" ; } |
730 |
# Banned. Use -DNOFOO=$(usex !foo) instead. |
731 |
cmake-utils_useno() { _cmake_banned_func "" "$@" ; } |
732 |
|
733 |
-# @FUNCTION: _cmake_modify-cmakelists |
734 |
-# @INTERNAL |
735 |
-# @DESCRIPTION: |
736 |
# Internal function for modifying hardcoded definitions. |
737 |
# Removes dangerous definitions that override Gentoo settings. |
738 |
- |
739 |
_cmake_modify-cmakelists() { |
740 |
debug-print-function ${FUNCNAME} "$@" |
741 |
|
742 |
|
743 |
diff --git a/eclass/cuda.eclass b/eclass/cuda.eclass |
744 |
index cfc42a85949..b1da77c69dd 100644 |
745 |
--- a/eclass/cuda.eclass |
746 |
+++ b/eclass/cuda.eclass |
747 |
@@ -25,11 +25,6 @@ esac |
748 |
# @EXAMPLE: |
749 |
# inherit cuda |
750 |
|
751 |
-# @VARIABLE: _CUDA_ECLASS |
752 |
-# @INTERNAL |
753 |
-# @DESCRIPTION: |
754 |
-# Please document me |
755 |
- |
756 |
if [[ -z ${_CUDA_ECLASS} ]]; then |
757 |
|
758 |
inherit flag-o-matic toolchain-funcs |
759 |
|
760 |
diff --git a/eclass/cvs.eclass b/eclass/cvs.eclass |
761 |
index f3d0d4f6b45..dd3cbe135a3 100644 |
762 |
--- a/eclass/cvs.eclass |
763 |
+++ b/eclass/cvs.eclass |
764 |
@@ -1,4 +1,4 @@ |
765 |
-# Copyright 1999-2019 Gentoo Authors |
766 |
+# Copyright 1999-2020 Gentoo Authors |
767 |
# Distributed under the terms of the GNU General Public License v2 |
768 |
|
769 |
# @ECLASS: cvs.eclass |
770 |
@@ -13,11 +13,6 @@ |
771 |
# cvs_src_unpack. If you find that you need to call the cvs_* functions |
772 |
# directly, I'd be interested to hear about it. |
773 |
|
774 |
-# @ECLASS-VARIABLE: _CVS_ECLASS |
775 |
-# @INTERNAL |
776 |
-# @DESCRIPTION: |
777 |
-# Please document |
778 |
- |
779 |
if [[ -z ${_CVS_ECLASS} ]]; then |
780 |
_CVS_ECLASS=1 |
781 |
|
782 |
@@ -200,11 +195,6 @@ case ${EAPI:-0} in |
783 |
esac |
784 |
|
785 |
# called from cvs_src_unpack |
786 |
- |
787 |
-# @FUNCTION: cvs_fetch |
788 |
-# @DESCRIPTION: |
789 |
-# Fetch CVS repo |
790 |
- |
791 |
cvs_fetch() { |
792 |
# Make these options local variables so that the global values are |
793 |
# not affected by modifications in this function. |
794 |
|
795 |
diff --git a/eclass/db-use.eclass b/eclass/db-use.eclass |
796 |
index de257a9ae23..7633425bac3 100644 |
797 |
--- a/eclass/db-use.eclass |
798 |
+++ b/eclass/db-use.eclass |
799 |
@@ -1,15 +1,8 @@ |
800 |
# Copyright 1999-2020 Gentoo Authors |
801 |
# Distributed under the terms of the GNU General Public License v2 |
802 |
- |
803 |
-# @ECLASS: db-use.eclass |
804 |
-# @MAINTAINER: |
805 |
-# maintainer-needed@g.o |
806 |
-# @AUTHOR: |
807 |
-# Paul de Vrieze <pauldv@g.o> |
808 |
-# @SUPPORTED_EAPIS: 0 1 2 3 4 5 6 7 |
809 |
-# @BLURB: functions that aid the use of sys-libs/db |
810 |
-# @DESCRIPTION: |
811 |
-# functions that aid in the use of sys-libs/db |
812 |
+# This is a common location for functions that aid the use of sys-libs/db |
813 |
+# |
814 |
+# Bugs: maintainer-needed@g.o |
815 |
|
816 |
# multilib is used for get_libname in all EAPI |
817 |
case "${EAPI:-0}" in |
818 |
@@ -17,10 +10,7 @@ case "${EAPI:-0}" in |
819 |
*) inherit multilib ;; |
820 |
esac |
821 |
|
822 |
-# @FUNCTION: db_ver_to_slot |
823 |
-# @USAGE: <version> |
824 |
-# @DESCRIPTION: |
825 |
-# Convert a version to a db slot |
826 |
+#Convert a version to a db slot |
827 |
db_ver_to_slot() { |
828 |
if [ $# -ne 1 ]; then |
829 |
eerror "Function db_ver_to_slot needs one argument" >&2 |
830 |
@@ -38,10 +28,7 @@ db_ver_to_slot() { |
831 |
echo -n "$1" |
832 |
} |
833 |
|
834 |
-# @FUNCTION: db_findver |
835 |
-# @USAGE: <atom> |
836 |
-# @DESCRIPTION: |
837 |
-# Find the version that corresponds to the given atom |
838 |
+#Find the version that correspond to the given atom |
839 |
db_findver() { |
840 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && EPREFIX= |
841 |
if [ $# -ne 1 ]; then |
842 |
@@ -65,9 +52,6 @@ db_findver() { |
843 |
fi |
844 |
} |
845 |
|
846 |
-# @FUNCTION: db_includedir |
847 |
-# @USAGE: <version> |
848 |
-# @DESCRIPTION: |
849 |
# Get the include dir for berkeley db. |
850 |
# This function has two modes. Without any arguments it will give the best |
851 |
# version available. With arguments that form the versions of db packages |
852 |
@@ -87,7 +71,7 @@ db_includedir() { |
853 |
return 1 |
854 |
fi |
855 |
else |
856 |
- # arguments given |
857 |
+ #arguments given |
858 |
for x in $@ |
859 |
do |
860 |
if VER=$(db_findver "=sys-libs/db-${x}*") && |
861 |
@@ -101,9 +85,7 @@ db_includedir() { |
862 |
fi |
863 |
} |
864 |
|
865 |
-# @FUNCTION: db_libname |
866 |
-# @USAGE: <version> |
867 |
-# @DESCRIPTION: |
868 |
+ |
869 |
# Get the library name for berkeley db. Something like "db-4.2" will be the |
870 |
# outcome. This function has two modes. Without any arguments it will give |
871 |
# the best version available. With arguments that form the versions of db |
872 |
@@ -121,7 +103,7 @@ db_libname() { |
873 |
return 1 |
874 |
fi |
875 |
else |
876 |
- # arguments given |
877 |
+ #arguments given |
878 |
for x in $@ |
879 |
do |
880 |
if VER=$(db_findver "=sys-libs/db-${x}*"); then |
881 |
|
882 |
diff --git a/eclass/db.eclass b/eclass/db.eclass |
883 |
index 8e20c249476..9a246d18979 100644 |
884 |
--- a/eclass/db.eclass |
885 |
+++ b/eclass/db.eclass |
886 |
@@ -1,4 +1,4 @@ |
887 |
-# Copyright 1999-2019 Gentoo Authors |
888 |
+# Copyright 1999-2020 Gentoo Authors |
889 |
# Distributed under the terms of the GNU General Public License v2 |
890 |
|
891 |
# @ECLASS: db.eclass |
892 |
@@ -16,10 +16,6 @@ DEPEND="test? ( >=dev-lang/tcl-8.4 )" |
893 |
|
894 |
RDEPEND="" |
895 |
|
896 |
-# @FUNCTION: db_fix_so |
897 |
-# @DESCRIPTION: |
898 |
-# Please document me |
899 |
- |
900 |
db_fix_so() { |
901 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && EROOT="${ROOT}" |
902 |
LIB="${EROOT}/usr/$(get_libdir)" |
903 |
@@ -73,10 +69,6 @@ db_fix_so() { |
904 |
fi |
905 |
} |
906 |
|
907 |
-# @FUNCTION: db_src_install_doc |
908 |
-# @DESCRIPTION: |
909 |
-# Please document me |
910 |
- |
911 |
db_src_install_doc() { |
912 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && ED="${D}" |
913 |
# not everybody wants this wad of documentation as it is primarily API docs |
914 |
@@ -91,10 +83,6 @@ db_src_install_doc() { |
915 |
db_src_install_examples |
916 |
} |
917 |
|
918 |
-# @FUNCTION: db_src_install_examples |
919 |
-# @DESCRIPTION: |
920 |
-# Please document me |
921 |
- |
922 |
db_src_install_examples() { |
923 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && ED="${D}" |
924 |
if use examples ; then |
925 |
@@ -114,10 +102,6 @@ db_src_install_examples() { |
926 |
fi |
927 |
} |
928 |
|
929 |
-# @FUNCTION: db_src_install_usrbinslot |
930 |
-# @DESCRIPTION: |
931 |
-# Please document me |
932 |
- |
933 |
db_src_install_usrbinslot() { |
934 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && ED="${D}" |
935 |
# slot all program names to avoid overwriting |
936 |
@@ -132,10 +116,6 @@ db_src_install_usrbinslot() { |
937 |
done |
938 |
} |
939 |
|
940 |
-# @FUNCTION: db_src_install_headerslot |
941 |
-# @DESCRIPTION: |
942 |
-# Please document me |
943 |
- |
944 |
db_src_install_headerslot() { |
945 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && ED="${D}" |
946 |
# install all headers in a slotted location |
947 |
@@ -143,10 +123,6 @@ db_src_install_headerslot() { |
948 |
mv "${ED}"/usr/include/*.h "${ED}"/usr/include/db${SLOT}/ || die |
949 |
} |
950 |
|
951 |
-# @FUNCTION: db_src_install_usrlibcleanup |
952 |
-# @DESCRIPTION: |
953 |
-# Please document me |
954 |
- |
955 |
db_src_install_usrlibcleanup() { |
956 |
has "${EAPI:-0}" 0 1 2 && ! use prefix && ED="${D}" |
957 |
LIB="${ED}/usr/$(get_libdir)" |
958 |
|
959 |
diff --git a/eclass/depend.apache.eclass b/eclass/depend.apache.eclass |
960 |
index 46bf93461bc..5aa55254268 100644 |
961 |
--- a/eclass/depend.apache.eclass |
962 |
+++ b/eclass/depend.apache.eclass |
963 |
@@ -127,11 +127,6 @@ APACHE2_4_DEPEND="=www-servers/apache-2.4*" |
964 |
# INTERNAL FUNCTIONS |
965 |
# ============================================================================== |
966 |
|
967 |
-# @FUNCTION: _init_apache2 |
968 |
-# @INTERNAL |
969 |
-# @DESCRIPTION: |
970 |
-# Please document me |
971 |
- |
972 |
_init_apache2() { |
973 |
debug-print-function $FUNCNAME $* |
974 |
|
975 |
@@ -153,21 +148,11 @@ _init_apache2() { |
976 |
esac |
977 |
} |
978 |
|
979 |
-# @FUNCTION: _init_apache2_late |
980 |
-# @INTERNAL |
981 |
-# @DESCRIPTION: |
982 |
-# Please document me |
983 |
- |
984 |
_init_apache2_late() { |
985 |
APACHE_BASEDIR="/usr/$(get_libdir)/apache2" |
986 |
APACHE_MODULESDIR="${APACHE_BASEDIR}/modules" |
987 |
} |
988 |
|
989 |
-# @FUNCTION: _init_no_apache |
990 |
-# @INTERNAL |
991 |
-# @DESCRIPTION: |
992 |
-# Please document me |
993 |
- |
994 |
_init_no_apache() { |
995 |
debug-print-function $FUNCNAME $* |
996 |
APACHE_VERSION="0" |
997 |
|
998 |
diff --git a/eclass/desktop.eclass b/eclass/desktop.eclass |
999 |
index 20b4d179730..7d5c0f0f9a2 100644 |
1000 |
--- a/eclass/desktop.eclass |
1001 |
+++ b/eclass/desktop.eclass |
1002 |
@@ -6,11 +6,6 @@ |
1003 |
# base-system@g.o |
1004 |
# @BLURB: support for desktop files, menus, and icons |
1005 |
|
1006 |
-# @VARIABLE: _DESKTOP_ECLASS |
1007 |
-# @INTERNAL |
1008 |
-# @DESCRIPTION: |
1009 |
-# If null set to 1 |
1010 |
- |
1011 |
if [[ -z ${_DESKTOP_ECLASS} ]]; then |
1012 |
_DESKTOP_ECLASS=1 |
1013 |
|
1014 |
|
1015 |
diff --git a/eclass/distutils-r1.eclass b/eclass/distutils-r1.eclass |
1016 |
index d626d816369..5ffc91be479 100644 |
1017 |
--- a/eclass/distutils-r1.eclass |
1018 |
+++ b/eclass/distutils-r1.eclass |
1019 |
@@ -95,11 +95,6 @@ esac |
1020 |
# It needs to be set before the inherit line. |
1021 |
: ${DISTUTILS_USE_SETUPTOOLS:=bdepend} |
1022 |
|
1023 |
-# @VARIABLE: _DISTUTILS_R1 |
1024 |
-# @INTERNAL |
1025 |
-# @DESCRIPTION: |
1026 |
-# Please document me |
1027 |
- |
1028 |
if [[ ! ${_DISTUTILS_R1} ]]; then |
1029 |
|
1030 |
[[ ${EAPI} == [456] ]] && inherit eutils |
1031 |
@@ -1198,66 +1193,34 @@ distutils-r1_src_install() { |
1032 |
|
1033 |
# -- distutils.eclass functions -- |
1034 |
|
1035 |
-# @FUNCTION: distutils_get_intermediate_installation_image |
1036 |
-# @INTERNAL |
1037 |
-# @DESCRIPTION: |
1038 |
-# Die and warn when function from previous distutils is called |
1039 |
distutils_get_intermediate_installation_image() { |
1040 |
die "${FUNCNAME}() is invalid for distutils-r1" |
1041 |
} |
1042 |
|
1043 |
-# @FUNCTION: distutils_src_unpack |
1044 |
-# @INTERNAL |
1045 |
-# @DESCRIPTION: |
1046 |
-# Die and warn when function from previous distutils is called |
1047 |
distutils_src_unpack() { |
1048 |
die "${FUNCNAME}() is invalid for distutils-r1, and you don't want it in EAPI ${EAPI} anyway" |
1049 |
} |
1050 |
|
1051 |
-# @FUNCTION: distutils_src_prepare |
1052 |
-# @INTERNAL |
1053 |
-# @DESCRIPTION: |
1054 |
-# Die and warn when function from previous distutils is called |
1055 |
distutils_src_prepare() { |
1056 |
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}" |
1057 |
} |
1058 |
|
1059 |
-# @FUNCTION: distutils_src_compile |
1060 |
-# @INTERNAL |
1061 |
-# @DESCRIPTION: |
1062 |
-# Die and warn when function from previous distutils is called |
1063 |
distutils_src_compile() { |
1064 |
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}" |
1065 |
} |
1066 |
|
1067 |
-# @FUNCTION: distutils_src_test |
1068 |
-# @INTERNAL |
1069 |
-# @DESCRIPTION: |
1070 |
-# Die and warn when function from previous distutils is called |
1071 |
distutils_src_test() { |
1072 |
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}" |
1073 |
} |
1074 |
|
1075 |
-# @FUNCTION: distutils_src_install |
1076 |
-# @INTERNAL |
1077 |
-# @DESCRIPTION: |
1078 |
-# Die and warn when function from previous distutils is called |
1079 |
distutils_src_install() { |
1080 |
die "${FUNCNAME}() is invalid for distutils-r1, you probably want: ${FUNCNAME/_/-r1_}" |
1081 |
} |
1082 |
|
1083 |
-# @FUNCTION: distutils_pkg_postinst |
1084 |
-# @INTERNAL |
1085 |
-# @DESCRIPTION: |
1086 |
-# Die and warn when function from previous distutils is called |
1087 |
distutils_pkg_postinst() { |
1088 |
die "${FUNCNAME}() is invalid for distutils-r1, and pkg_postinst is unnecessary" |
1089 |
} |
1090 |
|
1091 |
-# @FUNCTION: distutils_pkg_postrm |
1092 |
-# @INTERNAL |
1093 |
-# @DESCRIPTION: |
1094 |
-# Die and warn when function from previous distutils is called |
1095 |
distutils_pkg_postrm() { |
1096 |
die "${FUNCNAME}() is invalid for distutils-r1, and pkg_postrm is unnecessary" |
1097 |
} |
1098 |
|
1099 |
diff --git a/eclass/docs.eclass b/eclass/docs.eclass |
1100 |
index a8b1549dda3..adacae4abda 100644 |
1101 |
--- a/eclass/docs.eclass |
1102 |
+++ b/eclass/docs.eclass |
1103 |
@@ -118,12 +118,11 @@ case ${DOCS_BUILDER} in |
1104 |
;; |
1105 |
esac |
1106 |
|
1107 |
-# @FUNCTION: python_append_deps |
1108 |
+# @FUNCTION: python_append_dep |
1109 |
# @DESCRIPTION: |
1110 |
# Appends [\${PYTHON_USEDEP}] to all dependencies |
1111 |
# for python based DOCS_BUILDERs such as mkdocs or |
1112 |
# sphinx. |
1113 |
- |
1114 |
python_append_deps() { |
1115 |
debug-print-function ${FUNCNAME} |
1116 |
|
1117 |
@@ -333,10 +332,5 @@ if [[ ${_DISTUTILS_R1} && ( ${DOCS_BUILDER}="mkdocs" || ${DOCS_BUILDER}="sphinx" |
1118 |
python_compile_all() { docs_compile; } |
1119 |
fi |
1120 |
|
1121 |
-# @ECLASS-VARIABLE: _DOCS |
1122 |
-# @INTERNAL |
1123 |
-# @DESCRIPTION: |
1124 |
-# Please document |
1125 |
- |
1126 |
_DOCS=1 |
1127 |
fi |
1128 |
|
1129 |
diff --git a/eclass/dotnet.eclass b/eclass/dotnet.eclass |
1130 |
index f15b7f55fcc..ae861daf6e7 100644 |
1131 |
--- a/eclass/dotnet.eclass |
1132 |
+++ b/eclass/dotnet.eclass |
1133 |
@@ -2,8 +2,7 @@ |
1134 |
# Distributed under the terms of the GNU General Public License v2 |
1135 |
|
1136 |
# @ECLASS: dotnet.eclass |
1137 |
-# @MAINTAINER: |
1138 |
-# dotnet@g.o |
1139 |
+# @MAINTAINER: dotnet@g.o |
1140 |
# @SUPPORTED_EAPIS: 1 2 3 4 5 6 7 |
1141 |
# @BLURB: common settings and functions for mono and dotnet related packages |
1142 |
# @DESCRIPTION: |
1143 |
|
1144 |
diff --git a/eclass/ecm.eclass b/eclass/ecm.eclass |
1145 |
index 1d6d08e72a7..c763957bf89 100644 |
1146 |
--- a/eclass/ecm.eclass |
1147 |
+++ b/eclass/ecm.eclass |
1148 |
@@ -20,11 +20,6 @@ |
1149 |
# This eclass's phase functions are not intended to be mixed and matched, so if |
1150 |
# any phase functions are overridden the version here should also be called. |
1151 |
|
1152 |
-# @VARIABLE: _ECM_ECLASS |
1153 |
-# @INTERNAL |
1154 |
-# @DESCRIPTION: |
1155 |
-# Please document me |
1156 |
- |
1157 |
if [[ -z ${_ECM_ECLASS} ]]; then |
1158 |
_ECM_ECLASS=1 |
1159 |
|
1160 |
|
1161 |
diff --git a/eclass/elisp-common.eclass b/eclass/elisp-common.eclass |
1162 |
index fb4498ae086..66a3a325e67 100644 |
1163 |
--- a/eclass/elisp-common.eclass |
1164 |
+++ b/eclass/elisp-common.eclass |
1165 |
@@ -272,8 +272,6 @@ elisp-check-emacs-version() { |
1166 |
fi |
1167 |
} |
1168 |
|
1169 |
-# @FUNCTION: elisp-need-emacs |
1170 |
-# @DESCRIPTION: |
1171 |
# Test if the eselected Emacs version is at least the major version |
1172 |
# of GNU Emacs specified as argument. |
1173 |
# Return 0 if true, 1 if false, 2 if trouble. |
1174 |
|
1175 |
diff --git a/eclass/emboss-r2.eclass b/eclass/emboss-r2.eclass |
1176 |
index b260cd2736b..7d13f194eb7 100644 |
1177 |
--- a/eclass/emboss-r2.eclass |
1178 |
+++ b/eclass/emboss-r2.eclass |
1179 |
@@ -35,11 +35,6 @@ |
1180 |
# |
1181 |
# Defaults to the upstream name of the module. |
1182 |
|
1183 |
-# @VARIABLE: _EMBOSS_R2 |
1184 |
-# @INTERNAL |
1185 |
-# @DESCRIPTION: |
1186 |
-# Please document me |
1187 |
- |
1188 |
if [[ ! ${_EMBOSS_R2} ]]; then |
1189 |
|
1190 |
case ${EAPI:-0} in |
1191 |
|
1192 |
diff --git a/eclass/epatch.eclass b/eclass/epatch.eclass |
1193 |
index 921647e257a..fbb4f0b5bc0 100644 |
1194 |
--- a/eclass/epatch.eclass |
1195 |
+++ b/eclass/epatch.eclass |
1196 |
@@ -11,11 +11,6 @@ |
1197 |
# An eclass providing epatch and epatch_user functions to easily apply |
1198 |
# patches to ebuilds. Mostly superseded by eapply* in EAPI 6. |
1199 |
|
1200 |
-# @VARIABLE: _EPATCH_ECLASS |
1201 |
-# @INTERNAL |
1202 |
-# @DESCRIPTION: |
1203 |
-# Please document me |
1204 |
- |
1205 |
if [[ -z ${_EPATCH_ECLASS} ]]; then |
1206 |
|
1207 |
case ${EAPI:-0} in |
1208 |
|
1209 |
diff --git a/eclass/estack.eclass b/eclass/estack.eclass |
1210 |
index 37a2994283c..c0823adb03f 100644 |
1211 |
--- a/eclass/estack.eclass |
1212 |
+++ b/eclass/estack.eclass |
1213 |
@@ -1,4 +1,4 @@ |
1214 |
-# Copyright 1999-2019 Gentoo Authors |
1215 |
+# Copyright 1999-2020 Gentoo Authors |
1216 |
# Distributed under the terms of the GNU General Public License v2 |
1217 |
|
1218 |
# @ECLASS: estack.eclass |
1219 |
@@ -8,11 +8,6 @@ |
1220 |
# @DESCRIPTION: |
1221 |
# Support for storing values on stack-like variables. |
1222 |
|
1223 |
-# @VARIABLE: _ESTACK_ECLASS |
1224 |
-# @INTERNAL |
1225 |
-# @DESCRIPTION: |
1226 |
-# Please document me |
1227 |
- |
1228 |
if [[ -z ${_ESTACK_ECLASS} ]]; then |
1229 |
|
1230 |
# @FUNCTION: estack_push |
1231 |
|
1232 |
diff --git a/eclass/eutils.eclass b/eclass/eutils.eclass |
1233 |
index 0750da6019e..20ebe31c10a 100644 |
1234 |
--- a/eclass/eutils.eclass |
1235 |
+++ b/eclass/eutils.eclass |
1236 |
@@ -19,11 +19,6 @@ |
1237 |
# or eclasses. Use the more specific split eclasses instead, or native |
1238 |
# package manager functions when available. |
1239 |
|
1240 |
-# @ECLASS-VARIABLE: _EUTILS_ECLASS |
1241 |
-# @INTERNAL |
1242 |
-# @DESCRIPTION: |
1243 |
-# Please document me |
1244 |
- |
1245 |
if [[ -z ${_EUTILS_ECLASS} ]]; then |
1246 |
_EUTILS_ECLASS=1 |
1247 |
|
1248 |
@@ -74,10 +69,6 @@ emktemp() { |
1249 |
fi |
1250 |
} |
1251 |
|
1252 |
-# @FUNCTION: path_exists |
1253 |
-# @DESCRIPTION: |
1254 |
-# Warn that function has been removed |
1255 |
- |
1256 |
path_exists() { |
1257 |
eerror "path_exists has been removed. Please see the following post" |
1258 |
eerror "for a replacement snippet:" |
1259 |
|
1260 |
diff --git a/eclass/fcaps.eclass b/eclass/fcaps.eclass |
1261 |
index 107a519892d..4bef00d40ac 100644 |
1262 |
--- a/eclass/fcaps.eclass |
1263 |
+++ b/eclass/fcaps.eclass |
1264 |
@@ -28,11 +28,6 @@ |
1265 |
# ) |
1266 |
# @CODE |
1267 |
|
1268 |
-# @VARIABLE: _FCAPS_ECLASS |
1269 |
-# @INTERNAL |
1270 |
-# @DESCRIPTION: |
1271 |
-# Please document me |
1272 |
- |
1273 |
if [[ -z ${_FCAPS_ECLASS} ]]; then |
1274 |
_FCAPS_ECLASS=1 |
1275 |
|
1276 |
|
1277 |
diff --git a/eclass/findlib.eclass b/eclass/findlib.eclass |
1278 |
index aedcc6fad00..8fc5fd625a1 100644 |
1279 |
--- a/eclass/findlib.eclass |
1280 |
+++ b/eclass/findlib.eclass |
1281 |
@@ -1,4 +1,4 @@ |
1282 |
-# Copyright 1999-2019 Gentoo Authors |
1283 |
+# Copyright 1999-2020 Gentoo Authors |
1284 |
# Distributed under the terms of the GNU General Public License v2 |
1285 |
|
1286 |
# @ECLASS: findlib.eclass |
1287 |
@@ -16,10 +16,6 @@ |
1288 |
DEPEND=">=dev-ml/findlib-1.0.4-r1" |
1289 |
[[ ${FINDLIB_USE} ]] && DEPEND="${FINDLIB_USE}? ( ${DEPEND} )" |
1290 |
|
1291 |
-# @FUNCTION: check_ocamlfind |
1292 |
-# @DESCRIPTION: |
1293 |
-# Please document me |
1294 |
- |
1295 |
check_ocamlfind() { |
1296 |
if [ ! -x "${EPREFIX}"/usr/bin/ocamlfind ] |
1297 |
then |
1298 |
|
1299 |
diff --git a/eclass/fixheadtails.eclass b/eclass/fixheadtails.eclass |
1300 |
index 23f14692d5c..475b182843a 100644 |
1301 |
--- a/eclass/fixheadtails.eclass |
1302 |
+++ b/eclass/fixheadtails.eclass |
1303 |
@@ -8,11 +8,6 @@ |
1304 |
# Original author John Mylchreest <johnm@g.o> |
1305 |
# @BLURB: functions to replace obsolete head/tail with POSIX compliant ones |
1306 |
|
1307 |
-# @FUNCTION: _do_sed_fix |
1308 |
-# @INTERNAL |
1309 |
-# @DESCRIPTION: |
1310 |
-# Please document me |
1311 |
- |
1312 |
_do_sed_fix() { |
1313 |
einfo " - fixed $1" |
1314 |
sed -i \ |
1315 |
|
1316 |
diff --git a/eclass/flag-o-matic.eclass b/eclass/flag-o-matic.eclass |
1317 |
index f7786725c5b..20ee39d98ba 100644 |
1318 |
--- a/eclass/flag-o-matic.eclass |
1319 |
+++ b/eclass/flag-o-matic.eclass |
1320 |
@@ -9,29 +9,18 @@ |
1321 |
# This eclass contains a suite of functions to help developers sanely |
1322 |
# and safely manage toolchain flags in their builds. |
1323 |
|
1324 |
-# @ECLASS-VARIABLE: _FLAG_O_MATIC_ECLASS |
1325 |
-# @INTERNAL |
1326 |
-# @DESCRIPTION: |
1327 |
-# Please document me |
1328 |
- |
1329 |
if [[ -z ${_FLAG_O_MATIC_ECLASS} ]]; then |
1330 |
_FLAG_O_MATIC_ECLASS=1 |
1331 |
|
1332 |
inherit eutils toolchain-funcs multilib |
1333 |
|
1334 |
-# @FUNCTION: all-flag-vars |
1335 |
-# @DESCRIPTION: |
1336 |
# Return all the flag variables that our high level funcs operate on. |
1337 |
- |
1338 |
all-flag-vars() { |
1339 |
echo {ADA,C,CPP,CXX,CCAS,F,FC,LD}FLAGS |
1340 |
} |
1341 |
|
1342 |
-# @FUNCTION: setup-allowed-flags |
1343 |
-# @DESCRIPTION: |
1344 |
# {C,CPP,CXX,CCAS,F,FC,LD}FLAGS that we allow in strip-flags |
1345 |
# Note: shell globs and character lists are allowed |
1346 |
- |
1347 |
setup-allowed-flags() { |
1348 |
ALLOWED_FLAGS=( |
1349 |
-pipe -O '-O[12sg]' -mcpu -march -mtune |
1350 |
@@ -98,12 +87,8 @@ setup-allowed-flags() { |
1351 |
) |
1352 |
} |
1353 |
|
1354 |
-# @FUNCTION: _filter-hardened |
1355 |
-# @INTERNAL |
1356 |
-# @DESCRIPTION: |
1357 |
# inverted filters for hardened compiler. This is trying to unpick |
1358 |
# the hardened compiler defaults. |
1359 |
- |
1360 |
_filter-hardened() { |
1361 |
local f |
1362 |
for f in "$@" ; do |
1363 |
@@ -136,13 +121,9 @@ _filter-hardened() { |
1364 |
done |
1365 |
} |
1366 |
|
1367 |
-# @FUNCTION: _filter-var |
1368 |
-# @INTERNAL |
1369 |
-# @DESCRIPTION: |
1370 |
# Remove occurrences of strings from variable given in $1 |
1371 |
# Strings removed are matched as globs, so for example |
1372 |
# '-O*' would remove -O1, -O2 etc. |
1373 |
- |
1374 |
_filter-var() { |
1375 |
local f x var=$1 new=() |
1376 |
shift |
1377 |
@@ -161,7 +142,6 @@ _filter-var() { |
1378 |
# @USAGE: <flags> |
1379 |
# @DESCRIPTION: |
1380 |
# Remove particular <flags> from {C,CPP,CXX,CCAS,F,FC,LD}FLAGS. Accepts shell globs. |
1381 |
- |
1382 |
filter-flags() { |
1383 |
_filter-hardened "$@" |
1384 |
local v |
1385 |
@@ -174,7 +154,6 @@ filter-flags() { |
1386 |
# @FUNCTION: filter-lfs-flags |
1387 |
# @DESCRIPTION: |
1388 |
# Remove flags that enable Large File Support. |
1389 |
- |
1390 |
filter-lfs-flags() { |
1391 |
[[ $# -ne 0 ]] && die "filter-lfs-flags takes no arguments" |
1392 |
# http://www.gnu.org/s/libc/manual/html_node/Feature-Test-Macros.html |
1393 |
@@ -188,7 +167,6 @@ filter-lfs-flags() { |
1394 |
# @USAGE: <flags> |
1395 |
# @DESCRIPTION: |
1396 |
# Remove particular <flags> from LDFLAGS. Accepts shell globs. |
1397 |
- |
1398 |
filter-ldflags() { |
1399 |
_filter-var LDFLAGS "$@" |
1400 |
return 0 |
1401 |
@@ -335,11 +313,6 @@ replace-cpu-flags() { |
1402 |
return 0 |
1403 |
} |
1404 |
|
1405 |
-# @FUNCTION: _is_flagq |
1406 |
-# @INTERNAL |
1407 |
-# @DESCRIPTION: |
1408 |
-# Please document me |
1409 |
- |
1410 |
_is_flagq() { |
1411 |
local x var="$1[*]" |
1412 |
for x in ${!var} ; do |
1413 |
@@ -465,10 +438,6 @@ strip-flags() { |
1414 |
return 0 |
1415 |
} |
1416 |
|
1417 |
-# @FUNCTION: test-flag-PROG |
1418 |
-# @DESCRIPTION: |
1419 |
-# Please document me |
1420 |
- |
1421 |
test-flag-PROG() { |
1422 |
local comp=$1 |
1423 |
local lang=$2 |
1424 |
@@ -588,13 +557,8 @@ test-flag-FC() { test-flag-PROG "FC" f95 "$@"; } |
1425 |
# @USAGE: <flag> |
1426 |
# @DESCRIPTION: |
1427 |
# Returns shell true if <flag> is supported by the C compiler and linker, else returns shell false. |
1428 |
- |
1429 |
test-flag-CCLD() { test-flag-PROG "CC" c+ld "$@"; } |
1430 |
|
1431 |
-# @FUNCTION: test-flags-PROG |
1432 |
-# @DESCRIPTION: |
1433 |
-# Please document me |
1434 |
- |
1435 |
test-flags-PROG() { |
1436 |
local comp=$1 |
1437 |
local flags=() |
1438 |
|
1439 |
diff --git a/eclass/font-ebdftopcf.eclass b/eclass/font-ebdftopcf.eclass |
1440 |
index 9e00eec467f..29568e56013 100644 |
1441 |
--- a/eclass/font-ebdftopcf.eclass |
1442 |
+++ b/eclass/font-ebdftopcf.eclass |
1443 |
@@ -1,15 +1,12 @@ |
1444 |
# Copyright 1999-2020 Gentoo Authors |
1445 |
# Distributed under the terms of the GNU General Public License v2 |
1446 |
|
1447 |
-# @ECLASS: font-ebdftopcf.eclass |
1448 |
-# @MAINTAINER: |
1449 |
-# Robin H. Johnson <robbat2@g.o> |
1450 |
-# @AUTHOR: |
1451 |
-# Robin H. Johnson <robbat2@g.o> |
1452 |
-# @BLURB: A simple eclass to convert BDF to PCF |
1453 |
-# @DESCRIPTION: |
1454 |
-# Make PCF font generator from BDF uniform and optimal |
1455 |
+# Author: Robin H. Johnson <robbat2@g.o> |
1456 |
+ |
1457 |
+# font-ebdftopcf.eclass |
1458 |
+# Eclass to make PCF font generator from BDF uniform and optimal |
1459 |
# The manpage for this eclass is in media-gfx/ebdftopcf. |
1460 |
+ |
1461 |
# inherit this eclass after font.eclass |
1462 |
|
1463 |
# if USE="-X", this eclass is basically a no-op, since bdftopcf requires Xorg. |
1464 |
@@ -19,9 +16,9 @@ IUSE="X" |
1465 |
DEPEND="X? ( media-gfx/ebdftopcf )" |
1466 |
RDEPEND="" |
1467 |
|
1468 |
-# @FUNCTION: ebdftopcf |
1469 |
-# @DESCRIPTION: |
1470 |
-# Convert BDF files to PCF |
1471 |
+# |
1472 |
+# Public functions |
1473 |
+# |
1474 |
ebdftopcf() { |
1475 |
local bdffiles |
1476 |
bdffiles="$@" |
1477 |
@@ -32,9 +29,9 @@ ebdftopcf() { |
1478 |
|| die "Failed to build PCF files" |
1479 |
} |
1480 |
|
1481 |
-# @FUNCTION: font-ebdftopcf_src_compile |
1482 |
-# @DESCRIPTION: |
1483 |
-# Convert fonts from BDF to PCF |
1484 |
+# |
1485 |
+# Public inheritable functions |
1486 |
+# |
1487 |
font-ebdftopcf_src_compile() { |
1488 |
use X && FONT_SUFFIX="pcf.gz" |
1489 |
use X || FONT_SUFFIX="bdf" |
1490 |
|
1491 |
diff --git a/eclass/font.eclass b/eclass/font.eclass |
1492 |
index 10f4bf61e8d..e9e448a8155 100644 |
1493 |
--- a/eclass/font.eclass |
1494 |
+++ b/eclass/font.eclass |
1495 |
@@ -13,11 +13,6 @@ case ${EAPI:-0} in |
1496 |
*) die "EAPI ${EAPI} is not supported by font.eclass." ;; |
1497 |
esac |
1498 |
|
1499 |
-# @VARIABLE: _FONT_ECLASS |
1500 |
-# @INTERNAL |
1501 |
-# @DESCRIPTION: |
1502 |
-# Please document me |
1503 |
- |
1504 |
if [[ ! ${_FONT_ECLASS} ]]; then |
1505 |
|
1506 |
EXPORT_FUNCTIONS pkg_setup src_install pkg_postinst pkg_postrm |
1507 |
|
1508 |
diff --git a/eclass/fortran-2.eclass b/eclass/fortran-2.eclass |
1509 |
index 45f26a83c2b..6049b03b8f1 100644 |
1510 |
--- a/eclass/fortran-2.eclass |
1511 |
+++ b/eclass/fortran-2.eclass |
1512 |
@@ -36,11 +36,6 @@ esac |
1513 |
|
1514 |
EXPORT_FUNCTIONS pkg_setup |
1515 |
|
1516 |
-# @VARIABLE: _FORTRAN_2_CLASS |
1517 |
-# @INTERNAL |
1518 |
-# @DESCRIPTION: |
1519 |
-# Please document me |
1520 |
- |
1521 |
if [[ ! ${_FORTRAN_2_CLASS} ]]; then |
1522 |
|
1523 |
# @ECLASS-VARIABLE: FORTRAN_NEED_OPENMP |
1524 |
@@ -287,10 +282,5 @@ fortran-2_pkg_setup() { |
1525 |
fi |
1526 |
} |
1527 |
|
1528 |
-# @VARIABLE: _FORTRAN_2_ECLASS |
1529 |
-# @INTERNAL |
1530 |
-# @DESCRIPTION: |
1531 |
-# Please document me |
1532 |
- |
1533 |
_FORTRAN_2_ECLASS=1 |
1534 |
fi |
1535 |
|
1536 |
diff --git a/eclass/games.eclass b/eclass/games.eclass |
1537 |
index cdd40a22257..a2a5ce066a5 100644 |
1538 |
--- a/eclass/games.eclass |
1539 |
+++ b/eclass/games.eclass |
1540 |
@@ -26,10 +26,6 @@ |
1541 |
# is needed. For more details, see the QA team policies page: |
1542 |
# https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Policies#Games |
1543 |
|
1544 |
-# @VARIABLE: _GAMES_ECLASS |
1545 |
-# @INTERNAL |
1546 |
-# @DESCRIPTION: |
1547 |
-# Please document me |
1548 |
|
1549 |
if [[ -z ${_GAMES_ECLASS} ]]; then |
1550 |
_GAMES_ECLASS=1 |
1551 |
|
1552 |
diff --git a/eclass/gnuconfig.eclass b/eclass/gnuconfig.eclass |
1553 |
index 6ddaabff00a..3433837787c 100644 |
1554 |
--- a/eclass/gnuconfig.eclass |
1555 |
+++ b/eclass/gnuconfig.eclass |
1556 |
@@ -1,13 +1,8 @@ |
1557 |
# Copyright 1999-2020 Gentoo Authors |
1558 |
# Distributed under the terms of the GNU General Public License v2 |
1559 |
- |
1560 |
-# @ECLASS: gnuconfig.eclass |
1561 |
-# @MAINTAINER: |
1562 |
-# maintainer-needed@g.o |
1563 |
-# @AUTHOR: |
1564 |
-# Will Woods <wwoods@g.o> |
1565 |
-# @BLURB: Automatically update automake files to newest version |
1566 |
-# @DESCRIPTION: |
1567 |
+# |
1568 |
+# Author: Will Woods <wwoods@g.o> |
1569 |
+# |
1570 |
# This eclass is used to automatically update files that typically come with |
1571 |
# automake to the newest version available on the system. The most common use |
1572 |
# of this is to update config.guess and config.sub when configure dies from |
1573 |
@@ -25,8 +20,6 @@ |
1574 |
|
1575 |
DEPEND="sys-devel/gnuconfig" |
1576 |
|
1577 |
-# @FUNCTION: gnuconfig_update |
1578 |
-# @DESCRIPTION: |
1579 |
# Wrapper function for gnuconfig_do_update. If no arguments are given, update |
1580 |
# config.sub and config.guess (old default behavior), otherwise update the |
1581 |
# named files. |
1582 |
@@ -49,12 +42,10 @@ gnuconfig_update() { |
1583 |
return $? |
1584 |
} |
1585 |
|
1586 |
-# @FUNCTION: gnuconfig_do_update |
1587 |
-# @DESCRIPTION: |
1588 |
# Copy the newest available version of specified files over any old ones in the |
1589 |
# source dir. This function shouldn't be called directly - use gnuconfig_update |
1590 |
# |
1591 |
-# Note: that since bash using dynamic scoping, startdir is available here from |
1592 |
+# Note that since bash using dynamic scoping, startdir is available here from |
1593 |
# the gnuconfig_update function |
1594 |
gnuconfig_do_update() { |
1595 |
local configsubs_dir target targetlist file |
1596 |
@@ -84,8 +75,6 @@ gnuconfig_do_update() { |
1597 |
return 0 |
1598 |
} |
1599 |
|
1600 |
-# @FUNCTION: gnuconfig_findnewest |
1601 |
-# @DESCRIPTION: |
1602 |
# this searches the standard locations for the newest config.{sub|guess}, and |
1603 |
# returns the directory where they can be found. |
1604 |
gnuconfig_findnewest() { |
1605 |
|
1606 |
diff --git a/eclass/golang-vcs-snapshot.eclass b/eclass/golang-vcs-snapshot.eclass |
1607 |
index 1048cef492e..306db1f26c9 100644 |
1608 |
--- a/eclass/golang-vcs-snapshot.eclass |
1609 |
+++ b/eclass/golang-vcs-snapshot.eclass |
1610 |
@@ -1,11 +1,12 @@ |
1611 |
-# Copyright 1999-2019 Gentoo Authors |
1612 |
+# Copyright 1999-2020 Gentoo Authors |
1613 |
# Distributed under the terms of the GNU General Public License v2 |
1614 |
|
1615 |
# @ECLASS: golang-vcs-snapshot.eclass |
1616 |
# @MAINTAINER: |
1617 |
# William Hubbs <williamh@g.o> |
1618 |
# @SUPPORTED_EAPIS: 5 6 7 |
1619 |
-# @BLURB: support eclass for unpacking VCS snapshot tarballs |
1620 |
+# @BLURB: support eclass for unpacking VCS snapshot tarballs for |
1621 |
+# software written in the Go programming language |
1622 |
# @DESCRIPTION: |
1623 |
# This eclass provides a convenience src_unpack() which unpacks the |
1624 |
# first tarball mentioned in SRC_URI to its appropriate location in |
1625 |
@@ -62,10 +63,6 @@ EXPORT_FUNCTIONS src_unpack |
1626 |
declare -arg EGO_VENDOR |
1627 |
|
1628 |
_golang-vcs-snapshot_set_vendor_uri() { |
1629 |
- # @ECLASS-VARIABLE: EGO_VENDOR_URI |
1630 |
- # @DEFAULT_UNSET |
1631 |
- # @DESCRIPTION: |
1632 |
- # Determine the appropriate vendor URI |
1633 |
EGO_VENDOR_URI= |
1634 |
local lib |
1635 |
for lib in "${EGO_VENDOR[@]}"; do |
1636 |
|
1637 |
diff --git a/eclass/java-utils-2.eclass b/eclass/java-utils-2.eclass |
1638 |
index 84c09885c7b..b0d4d8acbef 100644 |
1639 |
--- a/eclass/java-utils-2.eclass |
1640 |
+++ b/eclass/java-utils-2.eclass |
1641 |
@@ -1,4 +1,4 @@ |
1642 |
-# Copyright 2004-2018 Gentoo Authors |
1643 |
+# Copyright 2004-2020 Gentoo Authors |
1644 |
# Distributed under the terms of the GNU General Public License v2 |
1645 |
|
1646 |
# @ECLASS: java-utils-2.eclass |
1647 |
@@ -1484,6 +1484,7 @@ java-pkg_ensure-vm-version-sufficient() { |
1648 |
|
1649 |
# @FUNCTION: java-pkg_is-vm-version-sufficient |
1650 |
# @INTERNAL |
1651 |
+# @DESCRIPTION: |
1652 |
# @RETURN: zero - VM is sufficient; non-zero - VM is not sufficient |
1653 |
java-pkg_is-vm-version-sufficient() { |
1654 |
debug-print-function ${FUNCNAME} $* |
1655 |
@@ -1563,8 +1564,8 @@ java-pkg_ensure-vm-version-ge() { |
1656 |
# Parameters: |
1657 |
# $@ - VM version to compare current VM to |
1658 |
# @CODE |
1659 |
-# @RETURN: zero - current VM version is greater than checked version |
1660 |
-# @RETURN: non-zero - current VM version is not greater than checked version |
1661 |
+# @RETURN: zero - current VM version is greater than checked version; |
1662 |
+# non-zero - current VM version is not greater than checked version |
1663 |
java-pkg_is-vm-version-ge() { |
1664 |
debug-print-function ${FUNCNAME} $* |
1665 |
|
1666 |
@@ -2591,14 +2592,14 @@ java-pkg_needs-vm() { |
1667 |
|
1668 |
# @FUNCTION: java-pkg_get-current-vm |
1669 |
# @INTERNAL |
1670 |
-# @RETURN: The current VM being used |
1671 |
+# @RETURN - The current VM being used |
1672 |
java-pkg_get-current-vm() { |
1673 |
java-config -f |
1674 |
} |
1675 |
|
1676 |
# @FUNCTION: java-pkg_get-vm-vendor |
1677 |
# @INTERNAL |
1678 |
-# @RETURN: The vendor of the current VM |
1679 |
+# @RETURN - The vendor of the current VM |
1680 |
java-pkg_get-vm-vendor() { |
1681 |
debug-print-function ${FUNCNAME} $* |
1682 |
|
1683 |
@@ -2609,7 +2610,7 @@ java-pkg_get-vm-vendor() { |
1684 |
|
1685 |
# @FUNCTION: java-pkg_get-vm-version |
1686 |
# @INTERNAL |
1687 |
-# @RETURN: The version of the current VM |
1688 |
+# @RETURN - The version of the current VM |
1689 |
java-pkg_get-vm-version() { |
1690 |
debug-print-function ${FUNCNAME} $* |
1691 |
|
1692 |
|
1693 |
diff --git a/eclass/mozextension.eclass b/eclass/mozextension.eclass |
1694 |
index 2e51180f1e5..c6276908b9f 100644 |
1695 |
--- a/eclass/mozextension.eclass |
1696 |
+++ b/eclass/mozextension.eclass |
1697 |
@@ -5,9 +5,7 @@ |
1698 |
# @MAINTAINER: |
1699 |
# Mozilla team <mozilla@g.o> |
1700 |
# @BLURB: Install extensions for use in mozilla products. |
1701 |
-# @DESCRIPTION: |
1702 |
-# Install extensions for use in mozilla products |
1703 |
- |
1704 |
+# |
1705 |
if [[ ! ${_MOZEXTENSION} ]]; then |
1706 |
|
1707 |
# @ECLASS-VARIABLE: MOZEXTENSION_TARGET |
1708 |
@@ -22,10 +20,6 @@ inherit eutils |
1709 |
|
1710 |
DEPEND="app-arch/unzip" |
1711 |
|
1712 |
-# @FUNCTION: mozversion_extension_location |
1713 |
-# @DESCRIPTION: |
1714 |
-# Get ${PN} from extension location |
1715 |
- |
1716 |
mozversion_extension_location() { |
1717 |
case ${PN} in |
1718 |
firefox|firefox-bin|palemoon) |
1719 |
@@ -38,10 +32,6 @@ mozversion_extension_location() { |
1720 |
return 1 |
1721 |
} |
1722 |
|
1723 |
-# @FUNCTION: xpi_unpack |
1724 |
-# @DESCRIPTION: |
1725 |
-# Unpack XPI files |
1726 |
- |
1727 |
xpi_unpack() { |
1728 |
local xpi xpiname srcdir |
1729 |
|
1730 |
@@ -71,9 +61,6 @@ xpi_unpack() { |
1731 |
done |
1732 |
} |
1733 |
|
1734 |
-# @FUNCTION: xpi_install |
1735 |
-# @DESCRIPTION: |
1736 |
-# Install XPI files |
1737 |
|
1738 |
xpi_install() { |
1739 |
local emid |
1740 |
@@ -104,10 +91,6 @@ xpi_install() { |
1741 |
doins -r "${x}"/* || die "failed to copy extension" |
1742 |
} |
1743 |
|
1744 |
-# @FUNCTION: xpi_copy |
1745 |
-# @DESCRIPTION: |
1746 |
-# Copy XPI files |
1747 |
- |
1748 |
xpi_copy() { |
1749 |
local emid |
1750 |
|
1751 |
|
1752 |
diff --git a/eclass/myspell-r2.eclass b/eclass/myspell-r2.eclass |
1753 |
index 088edf4e4a8..2de8d14c78b 100644 |
1754 |
--- a/eclass/myspell-r2.eclass |
1755 |
+++ b/eclass/myspell-r2.eclass |
1756 |
@@ -7,6 +7,7 @@ |
1757 |
# @AUTHOR: |
1758 |
# Tomáš Chvátal <scarabeus@g.o> |
1759 |
# @BLURB: An eclass to ease the construction of ebuilds for myspell dicts |
1760 |
+# @DESCRIPTION: |
1761 |
|
1762 |
EXPORT_FUNCTIONS src_unpack src_install |
1763 |
|
1764 |
|
1765 |
diff --git a/eclass/openib.eclass b/eclass/openib.eclass |
1766 |
index 685eaf344a7..a36f5cd85d0 100644 |
1767 |
--- a/eclass/openib.eclass |
1768 |
+++ b/eclass/openib.eclass |
1769 |
@@ -2,10 +2,8 @@ |
1770 |
# Distributed under the terms of the GNU General Public License v2 |
1771 |
|
1772 |
# @ECLASS: openib.eclass |
1773 |
-# @MAINTAINER: |
1774 |
-# maintainer-needed@g.o |
1775 |
# @AUTHOR: |
1776 |
-# Alexey Shvetsov <alexxy@g.o> |
1777 |
+# Original Author: Alexey Shvetsov <alexxy@g.o> |
1778 |
# @BLURB: Simplify working with OFED packages |
1779 |
|
1780 |
inherit eutils rpm versionator |
1781 |
|
1782 |
diff --git a/eclass/php-pear-r2.eclass b/eclass/php-pear-r2.eclass |
1783 |
index cd4625fdacc..d3887492047 100644 |
1784 |
--- a/eclass/php-pear-r2.eclass |
1785 |
+++ b/eclass/php-pear-r2.eclass |
1786 |
@@ -1,4 +1,4 @@ |
1787 |
-# Copyright 1999-2018 Gentoo Authors |
1788 |
+# Copyright 1999-2020 Gentoo Authors |
1789 |
# Distributed under the terms of the GNU General Public License v2 |
1790 |
|
1791 |
# @ECLASS: php-pear-r2.eclass |
1792 |
@@ -39,8 +39,7 @@ RDEPEND=">=dev-php/pear-1.8.1" |
1793 |
|
1794 |
# @ECLASS-VARIABLE: PEAR-P |
1795 |
# @INTERNAL |
1796 |
-# @DESCRIPTION: |
1797 |
-# Combines PHP_PEAR_PKG_NAME and PEAR_PV |
1798 |
+# @DESCRIPTION: Combines PHP_PEAR_PKG_NAME and PEAR_PV |
1799 |
PEAR_P="${PHP_PEAR_PKG_NAME}-${PEAR_PV}" |
1800 |
|
1801 |
# @ECLASS-VARIABLE: PHP_PEAR_DOMAIN |
1802 |
|
1803 |
diff --git a/eclass/portability.eclass b/eclass/portability.eclass |
1804 |
index 4a318178c72..333a9590b39 100644 |
1805 |
--- a/eclass/portability.eclass |
1806 |
+++ b/eclass/portability.eclass |
1807 |
@@ -13,6 +13,7 @@ _PORTABILITY_ECLASS=1 |
1808 |
|
1809 |
# @FUNCTION: treecopy |
1810 |
# @USAGE: <orig1> [orig2 orig3 ....] <dest> |
1811 |
+# @RETURN: |
1812 |
# @DESCRIPTION: |
1813 |
# mimic cp --parents copy, but working on BSD userland as well |
1814 |
treecopy() { |
1815 |
@@ -117,6 +118,7 @@ get_bmake() { |
1816 |
# @FUNCTION: get_mounts |
1817 |
# @USAGE: |
1818 |
# @RETURN: table of mounts in form "point node fs opts" |
1819 |
+# @MAINTAINER: |
1820 |
# @DESCRIPTION: |
1821 |
# Portable method of getting mount names and points. |
1822 |
# Returns as "point node fs options" |
1823 |
|
1824 |
diff --git a/eclass/postgres-multi.eclass b/eclass/postgres-multi.eclass |
1825 |
index 76916932042..49d5c6a9c68 100644 |
1826 |
--- a/eclass/postgres-multi.eclass |
1827 |
+++ b/eclass/postgres-multi.eclass |
1828 |
@@ -8,8 +8,7 @@ EXPORT_FUNCTIONS pkg_setup src_prepare src_compile src_install src_test |
1829 |
# @ECLASS: postgres-multi.eclass |
1830 |
# @MAINTAINER: |
1831 |
# PostgreSQL <pgsql-bugs@g.o> |
1832 |
-# @AUTHOR: |
1833 |
-# Aaron W. Swenson <titanofold@g.o> |
1834 |
+# @AUTHOR: Aaron W. Swenson <titanofold@g.o> |
1835 |
# @SUPPORTED_EAPIS: 5 6 7 |
1836 |
# @BLURB: An eclass to build PostgreSQL-related packages against multiple slots |
1837 |
# @DESCRIPTION: |
1838 |
|
1839 |
diff --git a/eclass/postgres.eclass b/eclass/postgres.eclass |
1840 |
index b7b45fd888d..2e2ac85ead6 100644 |
1841 |
--- a/eclass/postgres.eclass |
1842 |
+++ b/eclass/postgres.eclass |
1843 |
@@ -7,8 +7,7 @@ EXPORT_FUNCTIONS pkg_setup |
1844 |
# @ECLASS: postgres.eclass |
1845 |
# @MAINTAINER: |
1846 |
# PostgreSQL <pgsql-bugs@g.o> |
1847 |
-# @AUTHOR: |
1848 |
-# Aaron W. Swenson <titanofold@g.o> |
1849 |
+# @AUTHOR: Aaron W. Swenson <titanofold@g.o> |
1850 |
# @SUPPORTED_EAPIS: 5 6 7 |
1851 |
# @BLURB: An eclass for PostgreSQL-related packages |
1852 |
# @DESCRIPTION: |
1853 |
|
1854 |
diff --git a/eclass/rebar.eclass b/eclass/rebar.eclass |
1855 |
index 17be853acfa..7f712905c40 100644 |
1856 |
--- a/eclass/rebar.eclass |
1857 |
+++ b/eclass/rebar.eclass |
1858 |
@@ -54,8 +54,8 @@ get_erl_libs() { |
1859 |
# @INTERNAL |
1860 |
# @USAGE: <project_name> |
1861 |
# @RETURN: full path with EPREFIX to a Erlang package/project on success, |
1862 |
-# @RETURN: code 1 when dependency is not found and code 2 if multiple versions of |
1863 |
-# @RETURN: dependency are found. |
1864 |
+# code 1 when dependency is not found and code 2 if multiple versions of |
1865 |
+# dependency are found. |
1866 |
# @DESCRIPTION: |
1867 |
# Find a Erlang package/project by name in Erlang lib directory. Project |
1868 |
# directory is usually suffixed with version. It is matched to '<project_name>' |
1869 |
|
1870 |
diff --git a/eclass/ruby-ng.eclass b/eclass/ruby-ng.eclass |
1871 |
index 628d04592ab..e52c507d801 100644 |
1872 |
--- a/eclass/ruby-ng.eclass |
1873 |
+++ b/eclass/ruby-ng.eclass |
1874 |
@@ -111,7 +111,6 @@ ruby_implementation_depend() { |
1875 |
# @FUNCTION: _ruby_get_all_impls |
1876 |
# @INTERNAL |
1877 |
# @RETURN: list of valid values in USE_RUBY |
1878 |
-# @DESCRIPTION: |
1879 |
# Return a list of valid implementations in USE_RUBY, skipping the old |
1880 |
# implementations that are no longer supported. |
1881 |
_ruby_get_all_impls() { |
1882 |
|
1883 |
diff --git a/eclass/ssl-cert.eclass b/eclass/ssl-cert.eclass |
1884 |
index c984cb3bfd3..fdd6775ffc7 100644 |
1885 |
--- a/eclass/ssl-cert.eclass |
1886 |
+++ b/eclass/ssl-cert.eclass |
1887 |
@@ -1,9 +1,8 @@ |
1888 |
-# Copyright 1999-2019 Gentoo Authors |
1889 |
+# Copyright 1999-2020 Gentoo Authors |
1890 |
# Distributed under the terms of the GNU General Public License v2 |
1891 |
|
1892 |
# @ECLASS: ssl-cert.eclass |
1893 |
# @MAINTAINER: |
1894 |
-# maintainer-needed@g.o |
1895 |
# @AUTHOR: |
1896 |
# Max Kalika <max@g.o> |
1897 |
# @SUPPORTED_EAPIS: 1 2 3 4 5 6 7 |
1898 |
|
1899 |
diff --git a/eclass/stardict.eclass b/eclass/stardict.eclass |
1900 |
index 075c832829b..5e96b01625c 100644 |
1901 |
--- a/eclass/stardict.eclass |
1902 |
+++ b/eclass/stardict.eclass |
1903 |
@@ -1,14 +1,11 @@ |
1904 |
# Copyright 1999-2020 Gentoo Authors |
1905 |
# Distributed under the terms of the GNU General Public License v2 |
1906 |
|
1907 |
-# @ECLASS: stardict.eclass |
1908 |
-# @MAINTAINER: |
1909 |
-# maintainer-needed@g.o |
1910 |
-# @AUTHOR: |
1911 |
-# Alastair Tse <liquidx@g.o> |
1912 |
-# @BLURB: eclass to do stardict dictionary installations. |
1913 |
- |
1914 |
-# @Usage: |
1915 |
+# Author : Alastair Tse <liquidx@g.o> |
1916 |
+# |
1917 |
+# Convienence class to do stardict dictionary installations. |
1918 |
+# |
1919 |
+# Usage: |
1920 |
# - Variables to set : |
1921 |
# * FROM_LANG - From this language |
1922 |
# * TO_LANG - To this language |
1923 |
|
1924 |
diff --git a/eclass/toolchain.eclass b/eclass/toolchain.eclass |
1925 |
index 095c53d4c1d..59f8660a3d9 100644 |
1926 |
--- a/eclass/toolchain.eclass |
1927 |
+++ b/eclass/toolchain.eclass |
1928 |
@@ -1,14 +1,8 @@ |
1929 |
# Copyright 1999-2020 Gentoo Authors |
1930 |
# Distributed under the terms of the GNU General Public License v2 |
1931 |
|
1932 |
-# @ECLASS: toolchain.eclass |
1933 |
-# @MAINTAINER: |
1934 |
-# Toolchain Ninjas <toolchain@g.o> |
1935 |
-# @AUTHOR: |
1936 |
-# Toolchain Ninjas <toolchain@g.o> |
1937 |
+# Maintainer: Toolchain Ninjas <toolchain@g.o> |
1938 |
# @SUPPORTED_EAPIS: 5 6 7 |
1939 |
-# @BLURB: Basic toolchain stuff |
1940 |
- |
1941 |
|
1942 |
DESCRIPTION="The GNU Compiler Collection" |
1943 |
HOMEPAGE="https://gcc.gnu.org/" |
1944 |
|
1945 |
diff --git a/eclass/vim-doc.eclass b/eclass/vim-doc.eclass |
1946 |
index 99b5d6b2d55..70a6e943e85 100644 |
1947 |
--- a/eclass/vim-doc.eclass |
1948 |
+++ b/eclass/vim-doc.eclass |
1949 |
@@ -1,11 +1,6 @@ |
1950 |
# Copyright 1999-2020 Gentoo Authors |
1951 |
# Distributed under the terms of the GNU General Public License v2 |
1952 |
- |
1953 |
-# @ECLASS: vim-doc.eclass |
1954 |
-# @MAINTAINER: |
1955 |
-# Vim project <vim@g.o> |
1956 |
-# @BLURB: Work with Vim documentation |
1957 |
-# @DESCRIPTION: |
1958 |
+# |
1959 |
# This eclass is used by vim.eclass and vim-plugin.eclass to update |
1960 |
# the documentation tags. This is necessary since vim doesn't look in |
1961 |
# /usr/share/vim/vimfiles/doc for documentation; it only uses the |