6:47 a.m.
Follow up to:
https://listman.redhat.com/archives/libvir-list/2021-July/msg00281.html
Peter Krempa (5):
virsh-host: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers
virsh-domain: Avoid 'vir' prefix for locally declared VIR_ENUM*
helpers
virsh-network: Avoid 'vir' prefix for locally declared VIR_ENUM*
helpers
virsh-volume: Avoid 'vir' prefix for locally declared VIR_ENUM*
helpers
syntax-check: Prohibit 'vir' prefix for enum implementations in virsh
build-aux/syntax-check.mk | 7 +++++++
tools/virsh-completer-domain.c | 8 ++++----
tools/virsh-completer-host.c | 2 +-
tools/virsh-domain.c | 18 +++++++++---------
tools/virsh-domain.h | 8 ++++----
tools/virsh-host.c | 4 ++--
tools/virsh-host.h | 2 +-
tools/virsh-network.c | 12 ++++++------
tools/virsh-volume.c | 6 +++---
9 files changed, 37 insertions(+), 30 deletions(-)
--
2.31.1
6:47 a.m.
New subject: [PATCH 1/5] virsh-host: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers
Stuff used in virsh should use 'virsh'.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
tools/virsh-completer-host.c | 2 +-
tools/virsh-domain.c | 2 +-
tools/virsh-host.c | 4 ++--
tools/virsh-host.h | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/tools/virsh-completer-host.c b/tools/virsh-completer-host.c
index d17bc5f5ce..3795d1fd3a 100644
--- a/tools/virsh-completer-host.c
+++ b/tools/virsh-completer-host.c
@@ -183,7 +183,7 @@ virshNodeSuspendTargetCompleter(vshControl *ctl G_GNUC_UNUSED,
ret = g_new0(char *, VIR_NODE_SUSPEND_TARGET_LAST + 1);
for (i = 0; i < VIR_NODE_SUSPEND_TARGET_LAST; i++)
- ret[i] = g_strdup(virNodeSuspendTargetTypeToString(i));
+ ret[i] = g_strdup(virshNodeSuspendTargetTypeToString(i));
return ret;
}
diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index 29748b0257..f59be4e29d 100644
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -3488,7 +3488,7 @@ cmdDomPMSuspend(vshControl *ctl, const vshCmd *cmd)
if (vshCommandOptStringReq(ctl, cmd, "target", &target) < 0)
goto cleanup;
- if ((suspendTarget = virNodeSuspendTargetTypeFromString(target)) < 0) {
+ if ((suspendTarget = virshNodeSuspendTargetTypeFromString(target)) < 0) {
vshError(ctl, "%s", _("Invalid target"));
goto cleanup;
}
diff --git a/tools/virsh-host.c b/tools/virsh-host.c
index f42e995122..7b47b7583d 100644
--- a/tools/virsh-host.c
+++ b/tools/virsh-host.c
@@ -951,7 +951,7 @@ cmdNodeMemStats(vshControl *ctl, const vshCmd *cmd)
* "nodesuspend" command
*/
-VIR_ENUM_IMPL(virNodeSuspendTarget,
+VIR_ENUM_IMPL(virshNodeSuspendTarget,
VIR_NODE_SUSPEND_TARGET_LAST,
"mem",
"disk",
@@ -998,7 +998,7 @@ cmdNodeSuspend(vshControl *ctl, const vshCmd *cmd)
if (vshCommandOptLongLong(ctl, cmd, "duration", &duration) < 0)
return false;
- if ((suspendTarget = virNodeSuspendTargetTypeFromString(target)) < 0) {
+ if ((suspendTarget = virshNodeSuspendTargetTypeFromString(target)) < 0) {
vshError(ctl, "%s", _("Invalid target"));
return false;
}
diff --git a/tools/virsh-host.h b/tools/virsh-host.h
index 840f0b4538..f12258018d 100644
--- a/tools/virsh-host.h
+++ b/tools/virsh-host.h
@@ -25,4 +25,4 @@
extern const vshCmdDef hostAndHypervisorCmds[];
-VIR_ENUM_DECL(virNodeSuspendTarget);
+VIR_ENUM_DECL(virshNodeSuspendTarget);
--
2.31.1
6:47 a.m.
New subject: [PATCH 2/5] virsh-domain: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers
Stuff used in virsh should use 'virsh'.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
tools/virsh-completer-domain.c | 8 ++++----
tools/virsh-domain.c | 16 ++++++++--------
tools/virsh-domain.h | 8 ++++----
3 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/tools/virsh-completer-domain.c b/tools/virsh-completer-domain.c
index 14e4d95ec3..0df11807e1 100644
--- a/tools/virsh-completer-domain.c
+++ b/tools/virsh-completer-domain.c
@@ -762,7 +762,7 @@ virshDomainSignalCompleter(vshControl *ctl G_GNUC_UNUSED,
tmp = g_new0(char *, VIR_DOMAIN_PROCESS_SIGNAL_LAST + 1);
for (i = 0; i < VIR_DOMAIN_PROCESS_SIGNAL_LAST; i++) {
- const char *name = virDomainProcessSignalTypeToString(i);
+ const char *name = virshDomainProcessSignalTypeToString(i);
tmp[i] = g_strdup(name);
}
@@ -783,7 +783,7 @@ virshDomainLifecycleCompleter(vshControl *ctl G_GNUC_UNUSED,
tmp = g_new0(char *, VIR_DOMAIN_LIFECYCLE_LAST + 1);
for (i = 0; i < VIR_DOMAIN_LIFECYCLE_LAST; i++) {
- const char *name = virDomainLifecycleTypeToString(i);
+ const char *name = virshDomainLifecycleTypeToString(i);
tmp[i] = g_strdup(name);
}
@@ -804,7 +804,7 @@ virshDomainLifecycleActionCompleter(vshControl *ctl G_GNUC_UNUSED,
tmp = g_new0(char *, VIR_DOMAIN_LIFECYCLE_ACTION_LAST + 1);
for (i = 0; i < VIR_DOMAIN_LIFECYCLE_ACTION_LAST; i++) {
- const char *action = virDomainLifecycleActionTypeToString(i);
+ const char *action = virshDomainLifecycleActionTypeToString(i);
tmp[i] = g_strdup(action);
}
@@ -956,7 +956,7 @@ virshDomainCoreDumpFormatCompleter(vshControl *ctl G_GNUC_UNUSED,
ret = g_new0(char *, VIR_DOMAIN_CORE_DUMP_FORMAT_LAST + 1);
for (i = 0; i < VIR_DOMAIN_CORE_DUMP_FORMAT_LAST; i++)
- ret[i] = g_strdup(virDomainCoreDumpFormatTypeToString(i));
+ ret[i] = g_strdup(virshDomainCoreDumpFormatTypeToString(i));
return ret;
}
diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index f59be4e29d..6fb057736b 100644
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -5410,7 +5410,7 @@ static const vshCmdOptDef opts_dump[] = {
{.name = NULL}
};
-VIR_ENUM_IMPL(virDomainCoreDumpFormat,
+VIR_ENUM_IMPL(virshDomainCoreDumpFormat,
VIR_DOMAIN_CORE_DUMP_FORMAT_LAST,
"elf",
"kdump-zlib",
@@ -5463,7 +5463,7 @@ doDump(void *opaque)
}
if (vshCommandOptStringQuiet(ctl, cmd, "format", &format) > 0)
{
- if ((dumpformat = virDomainCoreDumpFormatTypeFromString(format)) < 0) {
+ if ((dumpformat = virshDomainCoreDumpFormatTypeFromString(format)) < 0) {
vshError(ctl, _("format '%s' is not supported, expecting
"
"'kdump-zlib', 'kdump-lzo',
'kdump-snappy', "
"'win-dmp' or 'elf'"),
format);
@@ -5711,13 +5711,13 @@ static const vshCmdOptDef opts_setLifecycleAction[] = {
{.name = NULL}
};
-VIR_ENUM_IMPL(virDomainLifecycle,
+VIR_ENUM_IMPL(virshDomainLifecycle,
VIR_DOMAIN_LIFECYCLE_LAST,
"poweroff",
"reboot",
"crash");
-VIR_ENUM_IMPL(virDomainLifecycleAction,
+VIR_ENUM_IMPL(virshDomainLifecycleAction,
VIR_DOMAIN_LIFECYCLE_ACTION_LAST,
"destroy",
"restart",
@@ -5754,13 +5754,13 @@ cmdSetLifecycleAction(vshControl *ctl, const vshCmd *cmd)
return false;
}
- if ((tmpVal = virDomainLifecycleTypeFromString(typeStr)) < 0) {
+ if ((tmpVal = virshDomainLifecycleTypeFromString(typeStr)) < 0) {
vshError(ctl, _("Invalid lifecycle type '%s'."), typeStr);
return false;
}
type = tmpVal;
- if ((tmpVal = virDomainLifecycleActionTypeFromString(actionStr)) < 0) {
+ if ((tmpVal = virshDomainLifecycleActionTypeFromString(actionStr)) < 0) {
vshError(ctl, _("Invalid lifecycle action '%s'."), actionStr);
return false;
}
@@ -8894,7 +8894,7 @@ static const vshCmdOptDef opts_send_process_signal[] = {
{.name = NULL}
};
-VIR_ENUM_IMPL(virDomainProcessSignal,
+VIR_ENUM_IMPL(virshDomainProcessSignal,
VIR_DOMAIN_PROCESS_SIGNAL_LAST,
"nop", "hup", "int", "quit",
"ill", /* 0-4 */
"trap", "abrt", "bus", "fpe",
"kill", /* 5-9 */
@@ -8928,7 +8928,7 @@ static int getSignalNumber(const char *signame)
else if (STRPREFIX(p, "sig"))
p += 3;
- return virDomainProcessSignalTypeFromString(p);
+ return virshDomainProcessSignalTypeFromString(p);
}
static bool
diff --git a/tools/virsh-domain.h b/tools/virsh-domain.h
index 0c1cc7a630..a1ac1cf1d4 100644
--- a/tools/virsh-domain.h
+++ b/tools/virsh-domain.h
@@ -40,7 +40,7 @@ VIR_ENUM_DECL(virshDomainHostnameSource);
extern const vshCmdDef domManagementCmds[];
-VIR_ENUM_DECL(virDomainProcessSignal);
-VIR_ENUM_DECL(virDomainLifecycle);
-VIR_ENUM_DECL(virDomainLifecycleAction);
-VIR_ENUM_DECL(virDomainCoreDumpFormat);
+VIR_ENUM_DECL(virshDomainProcessSignal);
+VIR_ENUM_DECL(virshDomainLifecycle);
+VIR_ENUM_DECL(virshDomainLifecycleAction);
+VIR_ENUM_DECL(virshDomainCoreDumpFormat);
--
2.31.1
6:47 a.m.
New subject: [PATCH 3/5] virsh-network: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers
Stuff used in virsh should use 'virsh'.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
tools/virsh-network.c | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/tools/virsh-network.c b/tools/virsh-network.c
index d95db7f6d1..152df1086b 100644
--- a/tools/virsh-network.c
+++ b/tools/virsh-network.c
@@ -943,13 +943,13 @@ static const vshCmdOptDef opts_network_update[] = {
{.name = NULL}
};
-VIR_ENUM_DECL(virNetworkUpdateCommand);
-VIR_ENUM_IMPL(virNetworkUpdateCommand,
+VIR_ENUM_DECL(virshNetworkUpdateCommand);
+VIR_ENUM_IMPL(virshNetworkUpdateCommand,
VIR_NETWORK_UPDATE_COMMAND_LAST,
"none", "modify", "delete",
"add-last", "add-first");
-VIR_ENUM_DECL(virNetworkSection);
-VIR_ENUM_IMPL(virNetworkSection,
+VIR_ENUM_DECL(virshNetworkSection);
+VIR_ENUM_IMPL(virshNetworkSection,
VIR_NETWORK_SECTION_LAST,
"none", "bridge", "domain", "ip",
"ip-dhcp-host",
"ip-dhcp-range", "forward",
"forward-interface",
@@ -983,7 +983,7 @@ cmdNetworkUpdate(vshControl *ctl, const vshCmd *cmd)
/* "add" is a synonym for "add-last" */
command = VIR_NETWORK_UPDATE_COMMAND_ADD_LAST;
} else {
- command = virNetworkUpdateCommandTypeFromString(commandStr);
+ command = virshNetworkUpdateCommandTypeFromString(commandStr);
if (command <= 0 || command >= VIR_NETWORK_UPDATE_COMMAND_LAST) {
vshError(ctl, _("unrecognized command name '%s'"),
commandStr);
goto cleanup;
@@ -993,7 +993,7 @@ cmdNetworkUpdate(vshControl *ctl, const vshCmd *cmd)
if (vshCommandOptStringReq(ctl, cmd, "section", §ionStr) < 0)
goto cleanup;
- section = virNetworkSectionTypeFromString(sectionStr);
+ section = virshNetworkSectionTypeFromString(sectionStr);
if (section <= 0 || section >= VIR_NETWORK_SECTION_LAST) {
vshError(ctl, _("unrecognized section name '%s'"),
sectionStr);
goto cleanup;
--
2.31.1
6:47 a.m.
New subject: [PATCH 4/5] virsh-volume: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers
Stuff used in virsh should use 'virsh'.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
tools/virsh-volume.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/tools/virsh-volume.c b/tools/virsh-volume.c
index 1da9b7217f..fe632b1b19 100644
--- a/tools/virsh-volume.c
+++ b/tools/virsh-volume.c
@@ -962,8 +962,8 @@ static const vshCmdOptDef opts_vol_wipe[] = {
{.name = NULL}
};
-VIR_ENUM_DECL(virStorageVolWipeAlgorithm);
-VIR_ENUM_IMPL(virStorageVolWipeAlgorithm,
+VIR_ENUM_DECL(virshStorageVolWipeAlgorithm);
+VIR_ENUM_IMPL(virshStorageVolWipeAlgorithm,
VIR_STORAGE_VOL_WIPE_ALG_LAST,
"zero", "nnsa", "dod", "bsi",
"gutmann", "schneier",
"pfitzner7", "pfitzner33", "random",
"trim");
@@ -985,7 +985,7 @@ cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
goto out;
if (algorithm_str &&
- (algorithm = virStorageVolWipeAlgorithmTypeFromString(algorithm_str)) < 0) {
+ (algorithm = virshStorageVolWipeAlgorithmTypeFromString(algorithm_str)) < 0)
{
vshError(ctl, _("Unsupported algorithm '%s'"), algorithm_str);
goto out;
}
--
2.31.1
6:47 a.m.
New subject: [PATCH 5/5] syntax-check: Prohibit 'vir' prefix for enum implementations in virsh
Avoid potential conflict of enum helpers declared in virsh.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
build-aux/syntax-check.mk | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/build-aux/syntax-check.mk b/build-aux/syntax-check.mk
index 256f9f695a..cedb360bfd 100644
--- a/build-aux/syntax-check.mk
+++ b/build-aux/syntax-check.mk
@@ -1717,6 +1717,13 @@ sc_group-qemu-caps:
$(AM_V_GEN)$(RUNUTF8) $(PYTHON) $(top_srcdir)/scripts/group-qemu-caps.py \
--check --prefix $(top_srcdir)/
+sc_prohibit_enum_impl_with_vir_prefix_in_virsh:
+ @prohibit='VIR_ENUM_(IMPL|DECL)\(vir[^s]' \
+ in_vc_files='tools/virsh.*\.[ch]$$' \
+ halt='avoid "vir" prefix for enums in virsh' \
+ $(_sc_search_regexp)
+
+
# List all syntax-check exemptions:
exclude_file_name_regexp--sc_avoid_strcase = ^tools/vsh\.h$$
--
2.31.1
7:10 a.m.
On a %A in %Y, Peter Krempa wrote:
Follow up to:
https://listman.redhat.com/archives/libvir-list/2021-July/msg00281.html
Peter Krempa (5):
virsh-host: Avoid 'vir' prefix for locally declared VIR_ENUM* helpers
virsh-domain: Avoid 'vir' prefix for locally declared VIR_ENUM*
helpers
virsh-network: Avoid 'vir' prefix for locally declared VIR_ENUM*
helpers
virsh-volume: Avoid 'vir' prefix for locally declared VIR_ENUM*
helpers
syntax-check: Prohibit 'vir' prefix for enum implementations in virsh
build-aux/syntax-check.mk | 7 +++++++
tools/virsh-completer-domain.c | 8 ++++----
tools/virsh-completer-host.c | 2 +-
tools/virsh-domain.c | 18 +++++++++---------
tools/virsh-domain.h | 8 ++++----
tools/virsh-host.c | 4 ++--
tools/virsh-host.h | 2 +-
tools/virsh-network.c | 12 ++++++------
tools/virsh-volume.c | 6 +++---
9 files changed, 37 insertions(+), 30 deletions(-)
Reviewed-by: Ján Tomko <jtomko(a)redhat.com>
Jano
1257
days inactive
1257
days old
6 comments
2 participants
participants (2)
-
Jano Tomko -
Peter Krempa