virsh: rename vshCommandOptString to vshCommandOptStringQuiet

This function does not set an error. Make it obvious in its name
to discourage its usage without reporting an error in the caller.

diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index b7e7606013ec16c8affe65663196e59cf30af24e..7650535b48573615d48fd7af9afc1ceafb41ceda 100644 (file)
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -1622,7 +1622,7 @@ cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
             goto save_error;
     }
 
-    rv = vshCommandOptString(ctl, cmd, "device-weights", &device_weight);
+    rv = vshCommandOptStringQuiet(ctl, cmd, "device-weights", &device_weight);
     if (rv < 0) {
         vshError(ctl, "%s", _("Unable to parse string parameter"));
         goto cleanup;
@@ -1633,7 +1633,7 @@ cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
             goto save_error;
     }
 
-    rv = vshCommandOptString(ctl, cmd, "device-read-iops-sec", &device_riops);
+    rv = vshCommandOptStringQuiet(ctl, cmd, "device-read-iops-sec", &device_riops);
     if (rv < 0) {
         vshError(ctl, "%s", _("Unable to parse string parameter"));
         goto cleanup;
@@ -1644,7 +1644,7 @@ cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
             goto save_error;
     }
 
-    rv = vshCommandOptString(ctl, cmd, "device-write-iops-sec", &device_wiops);
+    rv = vshCommandOptStringQuiet(ctl, cmd, "device-write-iops-sec", &device_wiops);
     if (rv < 0) {
         vshError(ctl, "%s", _("Unable to parse string parameter"));
         goto cleanup;
@@ -1655,7 +1655,7 @@ cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
             goto save_error;
     }
 
-    rv = vshCommandOptString(ctl, cmd, "device-read-bytes-sec", &device_rbps);
+    rv = vshCommandOptStringQuiet(ctl, cmd, "device-read-bytes-sec", &device_rbps);
     if (rv < 0) {
         vshError(ctl, "%s", _("Unable to parse string parameter"));
         goto cleanup;
@@ -1666,7 +1666,7 @@ cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
             goto save_error;
     }
 
-    rv = vshCommandOptString(ctl, cmd, "device-write-bytes-sec", &device_wbps);
+    rv = vshCommandOptStringQuiet(ctl, cmd, "device-write-bytes-sec", &device_wbps);
     if (rv < 0) {
         vshError(ctl, "%s", _("Unable to parse string parameter"));
         goto cleanup;
@@ -3736,7 +3736,7 @@ cmdUndefine(vshControl *ctl, const vshCmd *cmd)
     size_t j;
     virshControlPtr priv = ctl->privData;
 
-    ignore_value(vshCommandOptString(ctl, cmd, "storage", &vol_string));
+    ignore_value(vshCommandOptStringQuiet(ctl, cmd, "storage", &vol_string));
 
     if (!(vol_string || remove_all_storage) && wipe_storage) {
         vshError(ctl,
@@ -4115,7 +4115,7 @@ cmdStartGetFDs(vshControl *ctl,
     *nfdsret = 0;
     *fdsret = NULL;
 
-    if (vshCommandOptString(ctl, cmd, "pass-fds", &fdopt) <= 0)
+    if (vshCommandOptStringQuiet(ctl, cmd, "pass-fds", &fdopt) <= 0)
         return 0;
 
     if (!(fdlist = virStringSplit(fdopt, ",", -1))) {
@@ -5310,7 +5310,7 @@ doDump(void *opaque)
             goto out;
         }
 
-        if (vshCommandOptString(ctl, cmd, "format", &format) > 0) {
+        if (vshCommandOptStringQuiet(ctl, cmd, "format", &format) > 0) {
             if (STREQ(format, "kdump-zlib")) {
                 dumpformat = VIR_DOMAIN_CORE_DUMP_FORMAT_KDUMP_ZLIB;
             } else if (STREQ(format, "kdump-lzo")) {
@@ -8359,7 +8359,7 @@ cmdSendKey(vshControl *ctl, const vshCmd *cmd)
     if (!(dom = virshCommandOptDomain(ctl, cmd, NULL)))
         return false;
 
-    if (vshCommandOptString(ctl, cmd, "codeset", &codeset_option) <= 0)
+    if (vshCommandOptStringQuiet(ctl, cmd, "codeset", &codeset_option) <= 0)
         codeset_option = "linux";
 
     if (vshCommandOptUInt(ctl, cmd, "holdtime", &holdtime) < 0)
@@ -8775,7 +8775,7 @@ virshMemtuneGetSize(vshControl *ctl, const vshCmd *cmd,
     const char *str;
     char *end;
 
-    ret = vshCommandOptString(ctl, cmd, name, &str);
+    ret = vshCommandOptStringQuiet(ctl, cmd, name, &str);
     if (ret <= 0)
         return ret;
     if (virStrToLong_ll(str, &end, 10, value) < 0)

diff --git a/tools/virsh-nodedev.c b/tools/virsh-nodedev.c
index cc359e29962a5a093dc9730d4bd1aaa71f800b3c..bfe507ed609754f2c4fd2ca8ae045ab642761183 100644 (file)
--- a/tools/virsh-nodedev.c
+++ b/tools/virsh-nodedev.c
@@ -398,7 +398,7 @@ cmdNodeListDevices(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
     virshNodeDeviceListPtr list = NULL;
     int cap_type = -1;
 
-    ignore_value(vshCommandOptString(ctl, cmd, "cap", &cap_str));
+    ignore_value(vshCommandOptStringQuiet(ctl, cmd, "cap", &cap_str));
 
     if (cap_str) {
         if (tree) {
@@ -615,7 +615,7 @@ cmdNodeDeviceDetach(vshControl *ctl, const vshCmd *cmd)
     if (vshCommandOptStringReq(ctl, cmd, "device", &name) < 0)
         return false;
 
-    ignore_value(vshCommandOptString(ctl, cmd, "driver", &driverName));
+    ignore_value(vshCommandOptStringQuiet(ctl, cmd, "driver", &driverName));
 
     if (!(device = virNodeDeviceLookupByName(priv->conn, name))) {
         vshError(ctl, _("Could not find matching device '%s'"), name);

diff --git a/tools/virsh-volume.c b/tools/virsh-volume.c
index 7d76a0625b19780613efcf5f8d5b1767a23f9bb8..3408bee04c3a91113e6f63df73e82e2c1a854250 100644 (file)
--- a/tools/virsh-volume.c
+++ b/tools/virsh-volume.c
@@ -222,7 +222,7 @@ cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
         goto cleanup;
     }
 
-    if (vshCommandOptString(ctl, cmd, "allocation", &allocationStr) > 0 &&
+    if (vshCommandOptStringQuiet(ctl, cmd, "allocation", &allocationStr) > 0 &&
         virshVolSize(allocationStr, &allocation) < 0) {
         vshError(ctl, _("Malformed size %s"), allocationStr);
         goto cleanup;

diff --git a/tools/vsh.c b/tools/vsh.c
index e57c32466084281e6e1cc6621cb77ddf532a1faa..073347a390c68096df52bd62d8f93d686ad0daa5 100644 (file)
--- a/tools/vsh.c
+++ b/tools/vsh.c
@@ -944,21 +944,21 @@ vshCommandOptULWrap(vshControl *ctl, const vshCmd *cmd,
 }
 
 /**
- * vshCommandOptString:
+ * vshCommandOptStringQuiet:
  * @ctl virtshell control structure
  * @cmd command reference
  * @name option name
  * @value result
  *
- * Returns option as STRING
+ * Returns option as STRING. On error -1 is returned but no error is set.
  * Return value:
  * >0 if option found and valid (@value updated)
  * 0 if option not found and not required (@value untouched)
  * <0 in all other cases (@value untouched)
  */
 int
-vshCommandOptString(vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd,
-                    const char *name, const char **value)
+vshCommandOptStringQuiet(vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd,
+                         const char *name, const char **value)
 {
     vshCmdOpt *arg;
     int ret;
@@ -2793,7 +2793,7 @@ cmdHelp(vshControl *ctl, const vshCmd *cmd)
  {
     const char *name = NULL;
 
-    if (vshCommandOptString(ctl, cmd, "command", &name) <= 0) {
+    if (vshCommandOptStringQuiet(ctl, cmd, "command", &name) <= 0) {
         const vshCmdGrp *grp;
         const vshCmdDef *def;
 
@@ -2857,7 +2857,7 @@ cmdCd(vshControl *ctl, const vshCmd *cmd)
         return false;
     }
 
-    if (vshCommandOptString(ctl, cmd, "dir", &dir) <= 0)
+    if (vshCommandOptStringQuiet(ctl, cmd, "dir", &dir) <= 0)
         dir = dir_malloced = virGetUserDirectory();
     if (!dir)
         dir = "/";

diff --git a/tools/vsh.h b/tools/vsh.h
index fac62f4d4d9a72e0d9c05bc5a38011aafdea6bf8..9c0d8a6cb59feb546e9c494e569e7d5a77f9a0f4 100644 (file)
--- a/tools/vsh.h
+++ b/tools/vsh.h
@@ -270,8 +270,8 @@ int vshCommandOptUL(vshControl *ctl, const vshCmd *cmd,
 int vshCommandOptULWrap(vshControl *ctl, const vshCmd *cmd,
                         const char *name, unsigned long *value)
     ATTRIBUTE_NONNULL(4) ATTRIBUTE_RETURN_CHECK;
-int vshCommandOptString(vshControl *ctl, const vshCmd *cmd,
-                        const char *name, const char **value)
+int vshCommandOptStringQuiet(vshControl *ctl, const vshCmd *cmd,
+                             const char *name, const char **value)
     ATTRIBUTE_NONNULL(4) ATTRIBUTE_RETURN_CHECK;
 int vshCommandOptStringReq(vshControl *ctl, const vshCmd *cmd,
                            const char *name, const char **value)