Add comment headers to configuration and map files
[blkdevalias.git] / blkdevalias
index 1aadd7a..8a6dfa1 100755 (executable)
@@ -80,6 +80,15 @@ ba_usage () {
     exit 2
 }
 
+ba_store_wwid_map_header() {
+    local _TMP_MAP="$1"
+    cat > $_TMP_MAP << EOF
+# THIS FILE IS AUTOMATICALLY GENERATED. MANUAL EDITS
+# WILL BE LOST WHEN ALIASES ARE ADDED OR REMOVED.
+# <WWID> <ALIAS> <TYPE> <PARTNUM>
+EOF
+}
+
 # store the WWID map to disk
 ba_store_wwid_map() {
     local _WWID _TMP_MAP
@@ -88,8 +97,9 @@ ba_store_wwid_map() {
         _error "could not write temporary file"
         exit 1
     fi
+    ba_store_wwid_map_header $_TMP_MAP
     for _WWID in ${!WWIDMAP[@]}; do
-        _print "$_WWID ${WWIDMAP[$_WWID]}" \
+        echo "$_WWID ${WWIDMAP[$_WWID]}" \
                 "${TYPEMAP[$_WWID]} ${PARTMAP[$_WWID]}"
     done  >> $_TMP_MAP
     mv $_TMP_MAP $BA_MAP_PATH
@@ -243,6 +253,16 @@ ba_refresh_device () {
     $BA_SUDO $BA_SH -c "echo change > /sys/block/$_DEVNAME/uevent"
 }
 
+#ba_configure_store_header: <file>
+ba_store_conf_header() {
+    local _TMP_CONF="$1"
+    cat > $_TMP_CONF <<EOF
+# THIS FILE IS AUTOMATICALLY GENERATED. MANUAL EDITS
+# WILL BE LOST WHEN THE CONFIGURE COMMAND IS ISSUED.
+# SEE BLKDEVALIAS.CONF(5) FOR CONFIGURATION PARAMETERS.
+EOF
+}
+
 # ba_configure:
 ba_configure () {
     local _BA_USER _BA_GROUP _BA_DEV_PATH _TMP_CONF
@@ -294,6 +314,7 @@ EOF
         _error "could not write temporary file"
         exit 1
     fi
+    ba_store_conf_header $TMP_CONF
     echo "BA_DEV_PATH=\"$BA_DEV_PATH\"" >> $TMP_CONF
     echo "BA_USER=\"$BA_USER\"" >> $TMP_CONF
     _print "BA_GROUP=\"$BA_GROUP\"" >> $TMP_CONF