Add missing comments in blkdevalias
authorBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 21:52:45 +0000 (21:52 +0000)
committerBryn M. Reeves <bmr@redhat.com>
Mon, 21 Jan 2013 21:52:45 +0000 (21:52 +0000)
blkdevalias

index 0600ab2..41039c9 100755 (executable)
@@ -69,6 +69,8 @@ _debug () {
     [ "$BA_DEBUG" == "yes" ] && echo -e "$@" 1>&2
 }
 
+# print usage message
+# sub-commands may provide their own usage messages
 ba_usage () {
     if [ x"$@" == x"" ]; then
         _print "Usage: $0 <command> [<arg>]..."
@@ -170,6 +172,7 @@ ba_del_wwid_mapping() {
     unset PARTMAP[$_WWID]
 }
 
+# ba_get_partnum <device>
 ba_get_partnum () {
     local _DEV _NUM
     _DEV="$1"
@@ -192,6 +195,7 @@ ba_get_partnum () {
     _print $_NUM
 }
 
+# ba_scsi_id: <device path>
 ba_scsi_id () {
     local _DEV
     _DEV="$1"
@@ -236,6 +240,7 @@ ba_refresh_device () {
     $BA_SUDO $BA_SH -c "echo change > /sys/block/$_DEVNAME/uevent"
 }
 
+# ba_configure:
 ba_configure () {
     local _BA_USER _BA_GROUP _BA_DEV_PATH _TMP_CONF
     cat <<EOF
@@ -299,7 +304,7 @@ EOF
     _print -e "done\n"
 }
 
-# createdisk <alias> <device>
+# ba_createdisk <alias> <device>
 ba_createdisk () {
     local _WWID _DEV _ALIAS _TYPE _PART
     _ALIAS="$1"
@@ -330,6 +335,7 @@ ba_createdisk () {
     ba_refresh_device $_DEV
 }
 
+# ba_deletedisk: <alias>
 ba_deletedisk () {
     local _WWID _ALIAS _DEVPATH
     _ALIAS=$1
@@ -352,6 +358,7 @@ ba_deletedisk () {
     ba_refresh_device $_DEVPATH
 }
 
+# ba_list_disks:
 ba_list_disks () {
     local _D
     for _D in ${WWIDMAP[@]}; do
@@ -362,6 +369,7 @@ ba_list_disks () {
     done | sort -V
 }
 
+# ba_querydisk: <[-d]>
 ba_querydisk () {
     local _LISTDEV _ONDEV _WWID _ALIAS
     if [ "$1" == "-d" ]; then
@@ -393,6 +401,9 @@ ba_scandisks () {
     _warn "(unimplemented)"
 }
 
+# ba_map: <wwid>
+# DEVNAME - kernel name (supplied by udev)
+# ID_BUS  - bus ID string (supplied by udev)
 ba_map () {
     local _WWID _TYPE _PART
     _WWID="$1"