Skip to contentSkip to conversation

hw/s390x/s390-virtio-ccw: Improve the machine description string

PATCH In review Thomas Huth 2 participants 4 messages May 6, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 hw/s390x/s390-virtio-ccw: Improve the machine description string

The machine name already contains the words "ccw" and "virtio", so using "VirtIO-ccw" in the description likely does not really help the average user to get an idea what this machine type is about. Thus let's switch to "Virtual s390x machine" now, since "virtual machine" should be a familiar term, and "s390x" signals that this is about 64-bit guests (unlike S390 which could mean that it is 31-bit only).
Also expand "v" to "version, since this makes it easier to use this macro also with non-numeric machine names in downstream.

---
 hw/s390x/s390-virtio-ccw.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
hw/s390x/s390-virtio-ccw.c +1 -1
index 8fa488d13a..11a942a325 100644
@@ -768,7 +768,7 @@ bool css_migration_enabled(void)
     {                                                                         \
         MachineClass *mc = MACHINE_CLASS(oc);                                 \
         ccw_machine_##suffix##_class_options(mc);                             \
-        mc->desc = "VirtIO-ccw based S390 machine v" verstr;                  \
+        mc->desc = "Virtual s390x machine (version " verstr ")";      \
         if (latest) {                                                         \
             mc->alias = "s390-ccw-virtio";                                    \
             mc->is_default = true;                                            \
Signature · 1 line
2.27.0
#1 lore raw
Quoted 7 lines · Thomas Huth

The machine name already contains the words "ccw" and "virtio", so using "VirtIO-ccw" in the description likely does not really help the average user to get an idea what this machine type is about. Thus let's switch to "Virtual s390x machine" now, since "virtual machine" should be a familiar term, and "s390x" signals that this is about 64-bit guests (unlike S390 which could mean that it is 31-bit only).

Do we foresee any s390x machines that don't default to ccw virtio devices in the future?

Quoted 1 line

Also expand "v" to "version, since this makes it easier to use

s/"version/"version"/ :)

Quoted 20 lines

this macro also with non-numeric machine names in downstream.

---
 hw/s390x/s390-virtio-ccw.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
hw/s390x/s390-virtio-ccw.c +1 -1
index 8fa488d13a..11a942a325 100644
@@ -768,7 +768,7 @@ bool css_migration_enabled(void)
     {                                                                         \
         MachineClass *mc = MACHINE_CLASS(oc);                                 \
         ccw_machine_##suffix##_class_options(mc);                             \
-        mc->desc = "VirtIO-ccw based S390 machine v" verstr;                  \
+        mc->desc = "Virtual s390x machine (version " verstr ")";      \
         if (latest) {                                                         \
             mc->alias = "s390-ccw-virtio";                                    \
             mc->is_default = true;                                            \
#2 lore raw
Quoted 10 lines · Cornelia Huck
Quoted 7 lines · Thomas Huth

The machine name already contains the words "ccw" and "virtio", so using "VirtIO-ccw" in the description likely does not really help the average user to get an idea what this machine type is about. Thus let's switch to "Virtual s390x machine" now, since "virtual machine" should be a familiar term, and "s390x" signals that this is about 64-bit guests (unlike S390 which could mean that it is 31-bit only).

Quoted 2 lines

Do we foresee any s390x machines that don't default to ccw virtio devices in the future?

I don't think so. And if we ever get another type of para-virtualized machine, we still can change the description again to be more specific to distinguish them.

Quoted 3 lines
Quoted 1 line

Also expand "v" to "version, since this makes it easier to use

s/"version/"version"/ :)

Thanks!

Quoted 7 lines
Quoted 7 lines

this macro also with non-numeric machine names in downstream.

---
  hw/s390x/s390-virtio-ccw.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 14 lines

hw/s390x/s390-virtio-ccw.c bool css_migration_enabled(void) · line 774

Quoted 13 lines
hw/s390x/s390-virtio-ccw.c +1 -1
index 8fa488d13a..11a942a325 100644
@@ -768,7 +768,7 @@ bool css_migration_enabled(void)
      {                                                                         \
          MachineClass *mc = MACHINE_CLASS(oc);                                 \
          ccw_machine_##suffix##_class_options(mc);                             \
-        mc->desc = "VirtIO-ccw based S390 machine v" verstr;                  \
+        mc->desc = "Virtual s390x machine (version " verstr ")";      \
          if (latest) {                                                         \
              mc->alias = "s390-ccw-virtio";                                    \
              mc->is_default = true;                                            \

Thomas

Acked-by
#3 lore raw
Quoted 11 lines · Thomas Huth
Quoted 10 lines · Cornelia Huck
Quoted 7 lines · Thomas Huth

The machine name already contains the words "ccw" and "virtio", so using "VirtIO-ccw" in the description likely does not really help the average user to get an idea what this machine type is about. Thus let's switch to "Virtual s390x machine" now, since "virtual machine" should be a familiar term, and "s390x" signals that this is about 64-bit guests (unlike S390 which could mean that it is 31-bit only).

Quoted 6 lines
Quoted 2 lines

Do we foresee any s390x machines that don't default to ccw virtio devices in the future?

I don't think so. And if we ever get another type of para-virtualized machine, we still can change the description again to be more specific to distinguish them.

Fair enough.

Quoted 30 lines
Quoted 4 lines
Quoted 2 lines

Also expand "v" to "version, since this makes it easier to use

s/"version/"version"/ :)

Thanks!

Quoted 7 lines
Quoted 7 lines

this macro also with non-numeric machine names in downstream.

---
  hw/s390x/s390-virtio-ccw.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
Quoted 14 lines

hw/s390x/s390-virtio-ccw.c bool css_migration_enabled(void) · line 774

Quoted 13 lines
hw/s390x/s390-virtio-ccw.c +1 -1
index 8fa488d13a..11a942a325 100644
@@ -768,7 +768,7 @@ bool css_migration_enabled(void)
      {                                                                         \
          MachineClass *mc = MACHINE_CLASS(oc);                                 \
          ccw_machine_##suffix##_class_options(mc);                             \
-        mc->desc = "VirtIO-ccw based S390 machine v" verstr;                  \
+        mc->desc = "Virtual s390x machine (version " verstr ")";      \
          if (latest) {                                                         \
              mc->alias = "s390-ccw-virtio";                                    \
              mc->is_default = true;                                            \

Thomas