1 |
commit: 5c292df7bb4eed815b67e3f5359dbc7b8a7edb66 |
2 |
Author: Brian Evans <grknight <AT> gentoo <DOT> org> |
3 |
AuthorDate: Fri Nov 17 17:56:33 2017 +0000 |
4 |
Commit: Brian Evans <grknight <AT> gentoo <DOT> org> |
5 |
CommitDate: Fri Nov 17 17:56:33 2017 +0000 |
6 |
URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=5c292df7 |
7 |
|
8 |
mysql_fx.eclass: Fix documentation wrt bug 637818 |
9 |
|
10 |
Closes: https://bugs.gentoo.org/show_bug.cgi?id=637818 |
11 |
|
12 |
eclass/mysql_fx.eclass | 41 ++++++++++++++++++++++++++++------------- |
13 |
1 file changed, 28 insertions(+), 13 deletions(-) |
14 |
|
15 |
diff --git a/eclass/mysql_fx.eclass b/eclass/mysql_fx.eclass |
16 |
index ef9e36f5857..9d1e5967f67 100644 |
17 |
--- a/eclass/mysql_fx.eclass |
18 |
+++ b/eclass/mysql_fx.eclass |
19 |
@@ -1,17 +1,26 @@ |
20 |
-# Copyright 1999-2014 Gentoo Foundation |
21 |
+# Copyright 1999-2017 Gentoo Foundation |
22 |
# Distributed under the terms of the GNU General Public License v2 |
23 |
|
24 |
-# Author: Francesco Riosa (Retired) <vivo@g.o> |
25 |
-# Maintainer: |
26 |
+# DEPRECATED |
27 |
+# Recent versions have begun deprecating this eclass. |
28 |
+# Do not use it in new series. |
29 |
+ |
30 |
+# @ECLASS: mysql_fx.eclass |
31 |
+# @AUTHOR: Francesco Riosa (Retired) <vivo@g.o> |
32 |
+# @MAINTAINER: |
33 |
# - MySQL Team <mysql-bugs@g.o> |
34 |
# - Luca Longinotti <chtekk@g.o> |
35 |
+# @BLURB: This eclass provides some helper functions for mysql ebuilds |
36 |
+# @DESCRIPTION: |
37 |
+# This eclass providers helpers to build mysql servers including patching |
38 |
+# from an index and initializing certain variables as part of the build. |
39 |
|
40 |
inherit multilib |
41 |
|
42 |
-# |
43 |
+# @FUNCTION: stripdots |
44 |
+# @DESCRIPTION: |
45 |
# Helper function, version (integer) may have sections separated by dots |
46 |
# for readability. |
47 |
-# |
48 |
stripdots() { |
49 |
local dotver=${1:-"0"} |
50 |
local v="" |
51 |
@@ -39,12 +48,12 @@ stripdots() { |
52 |
fi |
53 |
} |
54 |
|
55 |
-# |
56 |
+# @FUNCTION: mysql_check_version_range |
57 |
+# @DESCRIPTION: |
58 |
# Check if a version number falls inside a given range. |
59 |
# The range includes the extremes and must be specified as |
60 |
# "low_version to high_version" i.e. "4.1.2 to 5.1.99.99". |
61 |
# Returns true if inside the range. |
62 |
-# |
63 |
mysql_check_version_range() { |
64 |
local lbound="${1%% to *}" ; lbound=$(stripdots "${lbound}") |
65 |
local rbound="${1#* to }" ; rbound=$(stripdots "${rbound}") |
66 |
@@ -53,9 +62,10 @@ mysql_check_version_range() { |
67 |
return 1 |
68 |
} |
69 |
|
70 |
-# |
71 |
+# @FUNCTION: _mysql_test_patch_ver_pn |
72 |
+# @INTERNAL |
73 |
+# @DESCRIPTION: |
74 |
# True if at least one applicable range is found for the patch. |
75 |
-# |
76 |
_mysql_test_patch_ver_pn() { |
77 |
local allelements=", version, package name" |
78 |
# So that it fails the directory test if none of them exist |
79 |
@@ -88,7 +98,8 @@ _mysql_test_patch_ver_pn() { |
80 |
return 1 |
81 |
} |
82 |
|
83 |
-# |
84 |
+# @FUNCTION: mysql_mv_patches |
85 |
+# @DESCRIPTION: |
86 |
# Parse a "index_file" looking for patches to apply to the |
87 |
# current MySQL version. |
88 |
# If the patch applies, print its description. |
89 |
@@ -119,6 +130,8 @@ mysql_mv_patches() { |
90 |
_mysql_mv_patches "${index_file}" "${my_ver}" "${my_test_fx}" |
91 |
} |
92 |
|
93 |
+# @FUNCTION: _mysql_mv_patches |
94 |
+# @INTERNAL |
95 |
_mysql_mv_patches() { |
96 |
local index_file="${1}" |
97 |
local my_ver="${2}" |
98 |
@@ -168,7 +181,8 @@ _mysql_mv_patches() { |
99 |
&& for (( i=0 ; $i < $ndsc ; i++ )) ; do einfo "> ${dsc[$i]}" ; done |
100 |
} |
101 |
|
102 |
-# |
103 |
+# @FUNCTION: mysql_version_is_at_least |
104 |
+# @DESCRIPTION: |
105 |
# Is $2 (defaults to $MYSQL_VERSION_ID) at least version $1? |
106 |
# (nice) idea from versionator.eclass |
107 |
# |
108 |
@@ -178,9 +192,10 @@ mysql_version_is_at_least() { |
109 |
[[ ${want_s} -le ${have_s} ]] && return 0 || return 1 |
110 |
} |
111 |
|
112 |
-# |
113 |
+# @FUNCTION: mysql_lib_symlinks |
114 |
+# @DESCRIPTION: |
115 |
# To be called on the live filesystem, reassigning symlinks of each MySQL |
116 |
-# library to the best version available. |
117 |
+# library to the best version available. (Obsolete) |
118 |
# |
119 |
mysql_lib_symlinks() { |