Gentoo Archives: gentoo-dev

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