Gentoo Archives: gentoo-commits

From: Justin Lecher <jlec@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] repo/gentoo:master commit in: eclass/
Date: Sat, 02 Jan 2016 10:41:38
Message-Id: 1451731286.1f24abe2d88ac2a4375ba6619a91ce3086dae6fa.jlec@gentoo
1 commit: 1f24abe2d88ac2a4375ba6619a91ce3086dae6fa
2 Author: Justin Lecher <jlec <AT> gentoo <DOT> org>
3 AuthorDate: Sun Dec 27 08:41:52 2015 +0000
4 Commit: Justin Lecher <jlec <AT> gentoo <DOT> org>
5 CommitDate: Sat Jan 2 10:41:26 2016 +0000
6 URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=1f24abe2
7
8 check-reqs.eclass: Mark interal function with @INTERNAL
9
10 Signed-off-by: Justin Lecher <jlec <AT> gentoo.org>
11
12 eclass/check-reqs.eclass | 10 ++++++++++
13 1 file changed, 10 insertions(+)
14
15 diff --git a/eclass/check-reqs.eclass b/eclass/check-reqs.eclass
16 index 219023e..3c98baf 100644
17 --- a/eclass/check-reqs.eclass
18 +++ b/eclass/check-reqs.eclass
19 @@ -108,6 +108,7 @@ check-reqs_pkg_pretend() {
20 }
21
22 # @FUNCTION: check-reqs_prepare
23 +# @INTERNAL
24 # @DESCRIPTION:
25 # Internal function that checks the variables that should be defined.
26 check-reqs_prepare() {
27 @@ -124,6 +125,7 @@ check-reqs_prepare() {
28 }
29
30 # @FUNCTION: check-reqs_run
31 +# @INTERNAL
32 # @DESCRIPTION:
33 # Internal function that runs the check based on variable settings.
34 check-reqs_run() {
35 @@ -158,6 +160,7 @@ check-reqs_run() {
36 }
37
38 # @FUNCTION: check-reqs_get_mebibytes
39 +# @INTERNAL
40 # @DESCRIPTION:
41 # Internal function that returns number in mebibytes.
42 # Returns 1024 for 1G or 1048576 for 1T.
43 @@ -180,6 +183,7 @@ check-reqs_get_mebibytes() {
44 }
45
46 # @FUNCTION: check-reqs_get_number
47 +# @INTERNAL
48 # @DESCRIPTION:
49 # Internal function that returns the numerical value without the unit.
50 # Returns "1" for "1G" or "150" for "150T".
51 @@ -203,6 +207,7 @@ check-reqs_get_number() {
52 }
53
54 # @FUNCTION: check-reqs_get_unit
55 +# @INTERNAL
56 # @DESCRIPTION:
57 # Internal function that return the unit without the numerical value.
58 # Returns "GiB" for "1G" or "TiB" for "150T".
59 @@ -224,6 +229,7 @@ check-reqs_get_unit() {
60 }
61
62 # @FUNCTION: check-reqs_output
63 +# @INTERNAL
64 # @DESCRIPTION:
65 # Internal function that prints the warning and dies if required based on
66 # the test results.
67 @@ -246,6 +252,7 @@ check-reqs_output() {
68 }
69
70 # @FUNCTION: check-reqs_memory
71 +# @INTERNAL
72 # @DESCRIPTION:
73 # Internal function that checks size of RAM.
74 check-reqs_memory() {
75 @@ -283,6 +290,7 @@ check-reqs_memory() {
76 }
77
78 # @FUNCTION: check-reqs_disk
79 +# @INTERNAL
80 # @DESCRIPTION:
81 # Internal function that checks space on the harddrive.
82 check-reqs_disk() {
83 @@ -316,6 +324,7 @@ check-reqs_disk() {
84 }
85
86 # @FUNCTION: check-reqs_start_phase
87 +# @INTERNAL
88 # @DESCRIPTION:
89 # Internal function that inform about started check
90 check-reqs_start_phase() {
91 @@ -331,6 +340,7 @@ check-reqs_start_phase() {
92 }
93
94 # @FUNCTION: check-reqs_unsatisfied
95 +# @INTERNAL
96 # @DESCRIPTION:
97 # Internal function that inform about check result.
98 # It has different output between pretend and setup phase,