Procházet zdrojové kódy

Sweep internals deeper under carpet

Single underscore will be used for not-so-hidden names.
Alois Mahdal před 7 roky
rodič
revize
67bad3188f
5 změnil soubory, kde provedl 87 přidání a 87 odebrání
  1. 24
    24
      src/include/build.sh
  2. 12
    12
      src/include/deploy.sh
  3. 17
    17
      src/include/ini.sh
  4. 7
    7
      src/include/mkit.sh
  5. 27
    27
      src/include/release.sh

+ 24
- 24
src/include/build.sh Zobrazit soubor

@@ -6,7 +6,7 @@ mkit_import ini
6 6
 mkit_import facts
7 7
 
8 8
 
9
-_build1() {
9
+__build1() {
10 10
     #
11 11
     # Process one skeleton $1 of type $3 (or guessed) to path $2
12 12
     #
@@ -14,26 +14,26 @@ _build1() {
14 14
     local dstpath=$2    # destination meaty animal path
15 15
     local ftype=$3      # file/builder type
16 16
     test -n "$dstpath"  || dstpath=${srcpath%.skel}
17
-    test -n "$ftype"    || ftype=$(_guess_ftype "$dstpath")
17
+    test -n "$ftype"    || ftype=$(__guess_ftype "$dstpath")
18 18
     debug_var srcpath dstpath ftype
19
-    <"$srcpath" _build1_ftype "$ftype" >"$dstpath"
19
+    <"$srcpath" __build1_ftype "$ftype" >"$dstpath"
20 20
     rec_built "$dstpath"
21 21
 }
22 22
 
23
-_build1_ftype() {
23
+__build1_ftype() {
24 24
     #
25 25
     # Build a file of type $1; fom stdin to stdout
26 26
     #
27 27
     local ftype=$1      # file/builder type
28 28
     case $ftype in
29
-        MKIT_COMMON)    _expand_tokens "tokens" ;;
30
-        rpmstuff)       _expand_tokens "tokens" "rpmstuff:tokens" ;;
31
-        debstuff)       _expand_tokens "tokens" "debstuff:tokens" ;;
29
+        MKIT_COMMON)    __expand_tokens "tokens" ;;
30
+        rpmstuff)       __expand_tokens "tokens" "rpmstuff:tokens" ;;
31
+        debstuff)       __expand_tokens "tokens" "debstuff:tokens" ;;
32 32
         *)              die "unknown file type: $ftype" ;;
33 33
     esac
34 34
 }
35 35
 
36
-_expand_tokens() {
36
+__expand_tokens() {
37 37
     #
38 38
     # Read stdin, expanding tokens from sections $@
39 39
     #
@@ -47,27 +47,27 @@ _expand_tokens() {
47 47
             debug_var section
48 48
             ini lskeys "$section" \
49 49
               | while read -r varname; do
50
-                    varvalue="$(ini 1value "$section:$varname" | _qfs )"
50
+                    varvalue="$(ini 1value "$section:$varname" | __qfs )"
51 51
                     echo "s|$varname|$varvalue|g;"
52 52
                     debug_var varname varvalue
53 53
                 done
54 54
         done
55
-        echo "s|__MKIT_PROJ_NAME__|$(ini 1value project:name | _qfs)|g;"
56
-        echo "s|__MKIT_PROJ_CODENAME__|$(ini 1value project:codename | _qfs)|g;"
57
-        echo "s|__MKIT_PROJ_LICENSE__|$(ini 1value project:license | _qfs)|g;"
58
-        echo "s|__MKIT_PROJ_PKGNAME__|$(ini 1value project:pkgname | _qfs)|g;"
59
-        echo "s|__MKIT_PROJ_TAGLINE__|$(ini 1value project:tagline | _qfs)|g;"
60
-        echo "s|__MKIT_PROJ_MAINTAINER__|$(ini 1value project:maintainer | _qfs)|g;"
61
-        echo "s|__MKIT_PROJ_VCS_BROWSER__|$(ini 1value project:vcs_browser | _qfs)|g;"
62
-        echo "s|__MKIT_PROJ_GIT_LASTHASH__|$(git_lasthash | _qfs)|g;"
63
-        echo "s|__MKIT_PROJ_VERSION__|$(semver | _qfs)|g;"
55
+        echo "s|__MKIT_PROJ_NAME__|$(ini 1value project:name | __qfs)|g;"
56
+        echo "s|__MKIT_PROJ_CODENAME__|$(ini 1value project:codename | __qfs)|g;"
57
+        echo "s|__MKIT_PROJ_LICENSE__|$(ini 1value project:license | __qfs)|g;"
58
+        echo "s|__MKIT_PROJ_PKGNAME__|$(ini 1value project:pkgname | __qfs)|g;"
59
+        echo "s|__MKIT_PROJ_TAGLINE__|$(ini 1value project:tagline | __qfs)|g;"
60
+        echo "s|__MKIT_PROJ_MAINTAINER__|$(ini 1value project:maintainer | __qfs)|g;"
61
+        echo "s|__MKIT_PROJ_VCS_BROWSER__|$(ini 1value project:vcs_browser | __qfs)|g;"
62
+        echo "s|__MKIT_PROJ_GIT_LASTHASH__|$(git_lasthash | __qfs)|g;"
63
+        echo "s|__MKIT_PROJ_VERSION__|$(semver | __qfs)|g;"
64 64
         echo "s|__MKIT_SELF_VERSION__|$MKIT_VERSION|g;"
65 65
     } >> "$script"
66
-    sed -f "$script" || die "_expand_tokens failed"
66
+    sed -f "$script" || die "__expand_tokens failed"
67 67
     rm "$script"
68 68
 }
69 69
 
70
-_guess_ftype() {
70
+__guess_ftype() {
71 71
     #
72 72
     # Guess file type from destination path $1
73 73
     #
@@ -77,7 +77,7 @@ _guess_ftype() {
77 77
     esac
78 78
 }
79 79
 
80
-_qfs() {
80
+__qfs() {
81 81
     #
82 82
     # Quote for our sed scipt's RHS
83 83
     #
@@ -95,7 +95,7 @@ build() {
95 95
     semver >/dev/null
96 96
     find . -type f -name '*.skel' \
97 97
      | while read -r srcpath; do
98
-           _build1 "$srcpath"
98
+           __build1 "$srcpath"
99 99
        done
100 100
 }
101 101
 
@@ -139,7 +139,7 @@ debstuff() {
139 139
       | while read -r dfsrc; do
140 140
             dftgt="debian/${dfsrc#$debian_skel}"
141 141
             mkdir -p "$(dirname "$dftgt")"
142
-            _build1 "$dfsrc" "$dftgt" debstuff
142
+            __build1 "$dfsrc" "$dftgt" debstuff
143 143
         done
144 144
     rec_built debian
145 145
 }
@@ -177,5 +177,5 @@ rpmstuff() {
177 177
     specsrc="$(ini 1value "dist:rpmstuff")"
178 178
     test -n "$specsrc" || die "dist:rpmstuff not specified"
179 179
     test -f "$specsrc" || die "specfile template not found: $specsrc"
180
-    _build1 "$specsrc" "$specname" rpmstuff
180
+    __build1 "$specsrc" "$specname" rpmstuff
181 181
 }

+ 12
- 12
src/include/deploy.sh Zobrazit soubor

@@ -4,11 +4,11 @@
4 4
 
5 5
 mkit_import ini
6 6
 
7
-_deploy_item() {
7
+__deploy_item() {
8 8
     #
9 9
     # Deploy item and make it look like wanted
10 10
     #
11
-    # usage: _deploy_item src dst [mode]
11
+    # usage: __deploy_item src dst [mode]
12 12
     #
13 13
     # Both src and dst must be names of actual items[1],
14 14
     # whereas dst must not exist.  On update, dst is
@@ -37,14 +37,14 @@ _deploy_item() {
37 37
                 [[ $item =~ .skel$ ]] \
38 38
                  && grep -q "${item%.skel}" "$MKIT_LOCAL/built.lst" \
39 39
                  && continue
40
-                _deploy_item "$item" "$dst${item#$src}" "$mode"
40
+                __deploy_item "$item" "$dst${item#$src}" "$mode"
41 41
             done
42 42
     else
43
-        _maybe install -DTvm "$mode" "$src" "$dst"
43
+        __maybe install -DTvm "$mode" "$src" "$dst"
44 44
     fi
45 45
 }
46 46
 
47
-_get_dst() {
47
+__get_dst() {
48 48
     #
49 49
     # Find out target path for src file $2 of group $1
50 50
     #
@@ -52,10 +52,10 @@ _get_dst() {
52 52
     local src=$2        # each source
53 53
     local dst=$3        # alternative destination name
54 54
     test -n "$dst" || dst=${src##*/}
55
-    echo "$(_get_root "$grp")/$dst"
55
+    echo "$(__get_root "$grp")/$dst"
56 56
 }
57 57
 
58
-_get_root() {
58
+__get_root() {
59 59
     #
60 60
     # Find out target root for group $1
61 61
     #
@@ -72,7 +72,7 @@ _get_root() {
72 72
     esac
73 73
 }
74 74
 
75
-_maybe() {
75
+__maybe() {
76 76
     #
77 77
     # Call the deploy command $1 $@ unless in dry mode
78 78
     #
@@ -101,8 +101,8 @@ install() {
101 101
             mode=$(ini 1value "modes:$group")
102 102
             ini values "files:$group" \
103 103
               | while read -r src dst; do
104
-                    dst=$(_get_dst "$group" "$src" "$dst")
105
-                    _deploy_item "$src" "$dst" "$mode"
104
+                    dst=$(__get_dst "$group" "$src" "$dst")
105
+                    __deploy_item "$src" "$dst" "$mode"
106 106
                 done
107 107
         done
108 108
     test -f "$MKIT_LOCAL/autoclean" && clean
@@ -122,8 +122,8 @@ uninstall() {
122 122
       | while read -r group; do
123 123
             ini values "files:$group" \
124 124
               | while read -r src dst; do
125
-                    dst=$(_get_dst "$group" "$src" "$dst")
126
-                    _maybe rm -vrf "$dst"
125
+                    dst=$(__get_dst "$group" "$src" "$dst")
126
+                    __maybe rm -vrf "$dst"
127 127
                 done
128 128
         done
129 129
 }

+ 17
- 17
src/include/ini.sh Zobrazit soubor

@@ -2,7 +2,7 @@
2 2
 # MKit - simple install helper
3 3
 # See LICENSE file for copyright and license details.
4 4
 
5
-_ini_cat() {
5
+__ini_cat() {
6 6
     #
7 7
     # A no-op for text stream
8 8
     #
@@ -12,7 +12,7 @@ _ini_cat() {
12 12
     done
13 13
 }
14 14
 
15
-_ini_expand() {
15
+__ini_expand() {
16 16
     #
17 17
     # Expand reference value (prefix only)
18 18
     #
@@ -30,7 +30,7 @@ _ini_expand() {
30 30
     done
31 31
 }
32 32
 
33
-_ini_grepkey() {
33
+__ini_grepkey() {
34 34
     #
35 35
     # Read key from a section
36 36
     #
@@ -40,10 +40,10 @@ _ini_grepkey() {
40 40
       | sed -e 's/ *= */=/; s/ +$//; s/^//;' \
41 41
       | grep -e "^$wnt=" \
42 42
       | cut -d= -f2- \
43
-      | _ini_maybe_expand
43
+      | __ini_maybe_expand
44 44
 }
45 45
 
46
-_ini_greppath() {
46
+__ini_greppath() {
47 47
     #
48 48
     # Read key from the right section
49 49
     #
@@ -62,10 +62,10 @@ _ini_greppath() {
62 62
          && echo "$override" \
63 63
          && return
64 64
     fi
65
-    _ini_grepsec "$wntsec" | _ini_grepkey "$wntkey"
65
+    __ini_grepsec "$wntsec" | __ini_grepkey "$wntkey"
66 66
 }
67 67
 
68
-_ini_grepsec() {
68
+__ini_grepsec() {
69 69
     #
70 70
     # Read one INI section
71 71
     #
@@ -85,22 +85,22 @@ _ini_grepsec() {
85 85
       | sed -e 's/ *= */=/; s/ +$//; s/^//;'
86 86
 }
87 87
 
88
-_ini_lskeys() {
88
+__ini_lskeys() {
89 89
     #
90 90
     # List keys from a section
91 91
     #
92 92
     local sct=$1    # section of interest
93
-    _ini_grepsec "$sct" | cut -d= -f1 | awk '!x[$0]++'
93
+    __ini_grepsec "$sct" | cut -d= -f1 | awk '!x[$0]++'
94 94
 }
95 95
 
96
-_ini_maybe_expand() {
96
+__ini_maybe_expand() {
97 97
     #
98 98
     # Decide whether or not to expand
99 99
     #
100 100
     if test "$MKIT_INI_EXPAND" -gt 0; then
101
-        MKIT_INI_EXPAND=$(( --MKIT_INI_EXPAND )) _ini_expand
101
+        MKIT_INI_EXPAND=$(( --MKIT_INI_EXPAND )) __ini_expand
102 102
     else
103
-        _ini_cat
103
+        __ini_cat
104 104
     fi
105 105
 }
106 106
 
@@ -111,12 +111,12 @@ ini() {
111 111
     local op=$1             # operator
112 112
     local arg=$2            # argument
113 113
     local fn                # internal function implementing $op
114
-    local limit=_ini_cat    # limiting internal function
114
+    local limit=__ini_cat    # limiting internal function
115 115
     case $op in
116
-        lskeys) fn=_ini_lskeys   ;;
117
-        sec)    fn=_ini_grepsec  ;;
118
-        values) fn=_ini_greppath ;;
119
-        1value) fn=_ini_greppath; limit="tail -1" ;;
116
+        lskeys) fn=__ini_lskeys   ;;
117
+        sec)    fn=__ini_grepsec  ;;
118
+        values) fn=__ini_greppath ;;
119
+        1value) fn=__ini_greppath; limit="tail -1" ;;
120 120
         *)      die "incorrect use of \`ini()\`"
121 121
     esac
122 122
     <"$MKIT_INI" $fn "$arg" | $limit

+ 7
- 7
src/include/mkit.sh Zobrazit soubor

@@ -30,7 +30,7 @@ mkit_import deploy
30 30
 mkit_import release
31 31
 mkit_import ini
32 32
 
33
-_valid_targets() {
33
+__valid_targets() {
34 34
     #
35 35
     # List valid routes
36 36
     #
@@ -75,7 +75,7 @@ debug_var() {
75 75
     done
76 76
 }
77 77
 
78
-_compver() {
78
+__compver() {
79 79
     #
80 80
     # True if version $1 matches our version
81 81
     #
@@ -102,7 +102,7 @@ _compver() {
102 102
     return 0
103 103
 }
104 104
 
105
-_chkiniversion() {
105
+__chkiniversion() {
106 106
     #
107 107
     # Check if ini version is supported
108 108
     #
@@ -120,7 +120,7 @@ _chkiniversion() {
120 120
     test -n "$ver_line" \
121 121
      || die "version mark ('#mkit version=x.y.z') not found in: $MKIT_INI"
122 122
     their_ver="$(tr -d '[:blank:]v' <<<"${ver_line##*=}")"
123
-    _compver "$their_ver" \
123
+    __compver "$their_ver" \
124 124
      || die "bad mkit.ini version: $their_ver does not match $MKIT_VERSION"
125 125
 }
126 126
 
@@ -159,7 +159,7 @@ mkit_init() {
159 159
     #shellcheck disable=SC2034
160 160
     MKIT_PROJ_PKGNAME=$(ini 1value "project:pkgname")
161 161
     test -f "$MKIT_INI" || die "cannot find mkit.ini: $MKIT_INI"
162
-    _chkiniversion
162
+    __chkiniversion
163 163
 }
164 164
 
165 165
 rec_built() {
@@ -175,14 +175,14 @@ route() {
175 175
     #
176 176
     # Call correct function based on $1
177 177
     #
178
-    if _valid_targets | grep -qwx "^$1"; then
178
+    if __valid_targets | grep -qwx "^$1"; then
179 179
         "$1"
180 180
     else
181 181
         {
182 182
             echo "usage: $(basename "$0") TARGET"
183 183
             echo
184 184
             echo "valid targets:"
185
-            _valid_targets | sed 's/^/    /'
185
+            __valid_targets | sed 's/^/    /'
186 186
         } >&2
187 187
     fi
188 188
 }

+ 27
- 27
src/include/release.sh Zobrazit soubor

@@ -5,7 +5,7 @@
5 5
 mkit_import ini
6 6
 mkit_import facts
7 7
 
8
-_bump_version() {
8
+__bump_version() {
9 9
     #
10 10
     # Bump version on stdin by level $1 (x, y or z)
11 11
     #
@@ -30,7 +30,7 @@ _bump_version() {
30 30
     echo "$new"
31 31
 }
32 32
 
33
-_relck() {
33
+__relck() {
34 34
     #
35 35
     # Die if blocking condition $1 is detected
36 36
     #
@@ -68,7 +68,7 @@ _relck() {
68 68
              && die "WIP commit since $(git_fact latest_tag)"
69 69
             ;;
70 70
         ini_version)
71
-            oracle=$(git_fact latest_version | _bump_version "$rlevel")
71
+            oracle=$(git_fact latest_version | __bump_version "$rlevel")
72 72
             ini 1value project:version  \
73 73
               | grep -qFx "$oracle" \
74 74
              || die "new version not in mkit.ini: $oracle"
@@ -79,7 +79,7 @@ _relck() {
79 79
     esac
80 80
 }
81 81
 
82
-_release() {
82
+__release() {
83 83
     #
84 84
     # Prepare release
85 85
     #
@@ -94,19 +94,19 @@ _release() {
94 94
     local relsrc        # release source branch (if any)
95 95
     local reldst        # release destination branch (if any)
96 96
 
97
-    _relck git_present
98
-    _relck at_relsrc
99
-    _relck not_dirty
100
-    _relck tags_ok
101
-    _relck vbump_hot
102
-    _relck no_wip
103
-    _relck ini_version
97
+    __relck git_present
98
+    __relck at_relsrc
99
+    __relck not_dirty
100
+    __relck tags_ok
101
+    __relck vbump_hot
102
+    __relck no_wip
103
+    __relck ini_version
104 104
 
105
-    newtag=$(git_fact latest_version | _bump_version "$rlevel" | git_ver2tag )
105
+    newtag=$(git_fact latest_version | __bump_version "$rlevel" | git_ver2tag )
106 106
     set -e
107 107
     debug_var newtag
108 108
     $MKIT_DRY && return
109
-    git tag -m "$(_release_msg)" "$newtag"
109
+    git tag -m "$(__release_msg)" "$newtag"
110 110
 
111 111
     relsrc=$(ini 1value project:relsrc)
112 112
     reldst=$(ini 1value project:reldst)
@@ -116,7 +116,7 @@ _release() {
116 116
     fi
117 117
 }
118 118
 
119
-_release_msg() {
119
+__release_msg() {
120 120
     #
121 121
     # Generate message for annotated tag
122 122
     #
@@ -133,7 +133,7 @@ _release_msg() {
133 133
       | tail -n +3
134 134
 }
135 135
 
136
-_vbump() {
136
+__vbump() {
137 137
     #
138 138
     # Do version bump at level $1
139 139
     #
@@ -142,10 +142,10 @@ _vbump() {
142 142
     #
143 143
     local rlevel=$1     # bump level (x, y or z)
144 144
     local nextver       # version after the bump
145
-    _relck git_present
146
-    _relck at_relsrc
147
-    _relck not_dirty
148
-    nextver=$(ini 1value project:version | _bump_version "$rlevel")
145
+    __relck git_present
146
+    __relck at_relsrc
147
+    __relck not_dirty
148
+    nextver=$(ini 1value project:version | __bump_version "$rlevel")
149 149
     debug_var nextver
150 150
     $MKIT_DRY && return
151 151
     update_version "$nextver" mkit.ini \
@@ -175,54 +175,54 @@ release() {
175 175
     #
176 176
     # Perform release on Z level
177 177
     #
178
-    _release z
178
+    __release z
179 179
 }
180 180
 
181 181
 release_x() {
182 182
     #
183 183
     # Perform release on X level
184 184
     #
185
-    _release x
185
+    __release x
186 186
 }
187 187
 
188 188
 release_y() {
189 189
     #
190 190
     # Perform release on Y level
191 191
     #
192
-    _release y
192
+    __release y
193 193
 }
194 194
 
195 195
 release_z() {
196 196
     #
197 197
     # Perform release on Z level
198 198
     #
199
-    _release z
199
+    __release z
200 200
 }
201 201
 
202 202
 vbump() {
203 203
     #
204 204
     # Perform version bump on Z level
205 205
     #
206
-    _vbump z
206
+    __vbump z
207 207
 }
208 208
 
209 209
 vbump_x() {
210 210
     #
211 211
     # Perform version bump on X level
212 212
     #
213
-    _vbump x
213
+    __vbump x
214 214
 }
215 215
 
216 216
 vbump_y() {
217 217
     #
218 218
     # Perform version bump on Y level
219 219
     #
220
-    _vbump y
220
+    __vbump y
221 221
 }
222 222
 
223 223
 vbump_z() {
224 224
     #
225 225
     # Perform version bump on Z level
226 226
     #
227
-    _vbump z
227
+    __vbump z
228 228
 }