Browse Source

Port docstrings from ffoo's mkit

Alois Mahdal 10 years ago
parent
commit
604e0cfda6
1 changed files with 12 additions and 0 deletions
  1. 12
    0
      setup/mk.sh

+ 12
- 0
setup/mk.sh View File

@@ -71,6 +71,9 @@ build() {
71 71
 }
72 72
 
73 73
 clean() {
74
+    #
75
+    # Clean up tree after building
76
+    #
74 77
     test -f built.list && {
75 78
         cat built.list | xargs rm -f
76 79
         rm -f built.list
@@ -78,6 +81,9 @@ clean() {
78 81
 }
79 82
 
80 83
 dist() {
84
+    #
85
+    # Create distributable tarball
86
+    #
81 87
     local version=$(get_version)
82 88
     local dirname=saturnin-$version
83 89
     mkdir -p $dirname
@@ -135,6 +141,9 @@ expand_variables() {
135 141
 }
136 142
 
137 143
 install() {
144
+    #
145
+    # Install product
146
+    #
138 147
     mkdir -vp $bindir \
139 148
               $shrdir/ffoo \
140 149
               $lexdir
@@ -218,6 +227,9 @@ get_version() {
218 227
 }
219 228
 
220 229
 uninstall() {
230
+    #
231
+    # Uninstall product
232
+    #
221 233
     list_of_installed_bins | xargs rm -vf
222 234
     rm -vrf $shrdir
223 235
     rm -vrf $lexdir