[libvirt] [PATCH 0/1] Function declarations match definitions
Interested in fixing mismatches between function parameter names in declarations (header files) and definitions (.c files)? This is a cosmetic / redability fix and does not change functionality. This is patch 1 of larger set of 22 patches that fix parameter names across the libvirt source code. If there is interest I can send the entire patch set. These are cosmetic redability fixes automatically generated by clang-tidy. make check and make syntax-check pass successfully after the 22 patches are applied. This is my first submission so please point out any issues and I will be glad to fix. Chris Venteicher (1): includes: function parameter names same in headers include/libvirt/libvirt-domain.h | 26 +++++++++++++------------- include/libvirt/libvirt-event.h | 4 ++-- include/libvirt/libvirt-host.h | 4 ++-- include/libvirt/libvirt-interface.h | 4 ++-- include/libvirt/libvirt-network.h | 6 +++--- include/libvirt/libvirt-nwfilter.h | 2 +- include/libvirt/libvirt-qemu.h | 2 +- include/libvirt/libvirt-secret.h | 4 ++-- include/libvirt/libvirt-storage.h | 12 ++++++------ include/libvirt/libvirt-stream.h | 22 +++++++++++----------- 10 files changed, 43 insertions(+), 43 deletions(-) -- 2.14.1
Headers use same function parameter names as definition code. --- include/libvirt/libvirt-domain.h | 26 +++++++++++++------------- include/libvirt/libvirt-event.h | 4 ++-- include/libvirt/libvirt-host.h | 4 ++-- include/libvirt/libvirt-interface.h | 4 ++-- include/libvirt/libvirt-network.h | 6 +++--- include/libvirt/libvirt-nwfilter.h | 2 +- include/libvirt/libvirt-qemu.h | 2 +- include/libvirt/libvirt-secret.h | 4 ++-- include/libvirt/libvirt-storage.h | 12 ++++++------ include/libvirt/libvirt-stream.h | 22 +++++++++++----------- 10 files changed, 43 insertions(+), 43 deletions(-) diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 4048acf38..60ec35d87 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -1088,7 +1088,7 @@ int virConnectNumOfDomains (virConnectPtr conn); /* * Get connection from domain. */ -virConnectPtr virDomainGetConnect (virDomainPtr domain); +virConnectPtr virDomainGetConnect (virDomainPtr dom); /* * Domain creation and destruction @@ -1109,7 +1109,7 @@ virDomainPtr virDomainLookupByID (virConnectPtr conn, virDomainPtr virDomainLookupByUUID (virConnectPtr conn, const unsigned char *uuid); virDomainPtr virDomainLookupByUUIDString (virConnectPtr conn, - const char *uuid); + const char *uuidstr); typedef enum { VIR_DOMAIN_SHUTDOWN_DEFAULT = 0, /* hypervisor choice */ @@ -1161,11 +1161,11 @@ int virDomainFree (virDomainPtr domain); */ int virDomainSuspend (virDomainPtr domain); int virDomainResume (virDomainPtr domain); -int virDomainPMSuspendForDuration (virDomainPtr domain, +int virDomainPMSuspendForDuration (virDomainPtr dom, unsigned int target, unsigned long long duration, unsigned int flags); -int virDomainPMWakeup (virDomainPtr domain, +int virDomainPMWakeup (virDomainPtr dom, unsigned int flags); /* * Domain save/restore @@ -1626,11 +1626,11 @@ int virDomainInterfaceStats (virDomainPtr dom, */ # define VIR_DOMAIN_BANDWIDTH_OUT_BURST "outbound.burst" -int virDomainSetInterfaceParameters (virDomainPtr dom, +int virDomainSetInterfaceParameters (virDomainPtr domain, const char *device, virTypedParameterPtr params, int nparams, unsigned int flags); -int virDomainGetInterfaceParameters (virDomainPtr dom, +int virDomainGetInterfaceParameters (virDomainPtr domain, const char *device, virTypedParameterPtr params, int *nparams, unsigned int flags); @@ -1697,7 +1697,7 @@ struct _virDomainBlockInfo { * offset, similar to 'ls')*/ }; -int virDomainGetBlockInfo(virDomainPtr dom, +int virDomainGetBlockInfo(virDomainPtr domain, const char *disk, virDomainBlockInfoPtr info, unsigned int flags); @@ -1869,7 +1869,7 @@ int virDomainPinEmulator (virDomainPtr domain, unsigned int flags); int virDomainGetEmulatorPinInfo (virDomainPtr domain, - unsigned char *cpumaps, + unsigned char *cpumap, int maplen, unsigned int flags); @@ -1889,7 +1889,7 @@ struct _virDomainIOThreadInfo { void virDomainIOThreadInfoFree(virDomainIOThreadInfoPtr info); -int virDomainGetIOThreadInfo(virDomainPtr domain, +int virDomainGetIOThreadInfo(virDomainPtr dom, virDomainIOThreadInfoPtr **info, unsigned int flags); int virDomainPinIOThread(virDomainPtr domain, @@ -2298,11 +2298,11 @@ void virDomainStatsRecordListFree(virDomainStatsRecordPtr *stats); */ # define VIR_PERF_PARAM_EMULATION_FAULTS "emulation_faults" -int virDomainGetPerfEvents(virDomainPtr dom, +int virDomainGetPerfEvents(virDomainPtr domain, virTypedParameterPtr *params, int *nparams, unsigned int flags); -int virDomainSetPerfEvents(virDomainPtr dom, +int virDomainSetPerfEvents(virDomainPtr domain, virTypedParameterPtr params, int nparams, unsigned int flags); @@ -3130,14 +3130,14 @@ typedef enum { * completed job */ } virDomainGetJobStatsFlags; -int virDomainGetJobInfo(virDomainPtr dom, +int virDomainGetJobInfo(virDomainPtr domain, virDomainJobInfoPtr info); int virDomainGetJobStats(virDomainPtr domain, int *type, virTypedParameterPtr *params, int *nparams, unsigned int flags); -int virDomainAbortJob(virDomainPtr dom); +int virDomainAbortJob(virDomainPtr domain); typedef enum { VIR_DOMAIN_JOB_OPERATION_UNKNOWN = 0, diff --git a/include/libvirt/libvirt-event.h b/include/libvirt/libvirt-event.h index 23227d090..0293a2841 100644 --- a/include/libvirt/libvirt-event.h +++ b/include/libvirt/libvirt-event.h @@ -179,11 +179,11 @@ int virEventAddHandle(int fd, int events, void virEventUpdateHandle(int watch, int events); int virEventRemoveHandle(int watch); -int virEventAddTimeout(int frequency, +int virEventAddTimeout(int timeout, virEventTimeoutCallback cb, void *opaque, virFreeCallback ff); -void virEventUpdateTimeout(int timer, int frequency); +void virEventUpdateTimeout(int timer, int timeout); int virEventRemoveTimeout(int timer); diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index 07b5d1594..bd8b7b551 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -665,8 +665,8 @@ char *virConnectBaselineCPU(virConnectPtr conn, int virNodeGetFreePages(virConnectPtr conn, unsigned int npages, unsigned int *pages, - int startcell, - unsigned int cellcount, + int startCell, + unsigned int cellCount, unsigned long long *counts, unsigned int flags); diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-interface.h index 60c53e6b4..3ea80b2f6 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -71,7 +71,7 @@ int virConnectListAllInterfaces (virConnectPtr conn, virInterfacePtr virInterfaceLookupByName (virConnectPtr conn, const char *name); virInterfacePtr virInterfaceLookupByMACString (virConnectPtr conn, - const char *mac); + const char *macstr); const char* virInterfaceGetName (virInterfacePtr iface); const char* virInterfaceGetMACString (virInterfacePtr iface); @@ -83,7 +83,7 @@ typedef enum { char * virInterfaceGetXMLDesc (virInterfacePtr iface, unsigned int flags); virInterfacePtr virInterfaceDefineXML (virConnectPtr conn, - const char *xmlDesc, + const char *xml, unsigned int flags); int virInterfaceUndefine (virInterfacePtr iface); diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-network.h index 308f27f64..7c518059b 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -50,7 +50,7 @@ typedef virNetwork *virNetworkPtr; /* * Get connection from network. */ -virConnectPtr virNetworkGetConnect (virNetworkPtr network); +virConnectPtr virNetworkGetConnect (virNetworkPtr net); /* * List active networks @@ -96,7 +96,7 @@ virNetworkPtr virNetworkLookupByName (virConnectPtr conn, virNetworkPtr virNetworkLookupByUUID (virConnectPtr conn, const unsigned char *uuid); virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr conn, - const char *uuid); + const char *uuidstr); /* * Create active transient network @@ -108,7 +108,7 @@ virNetworkPtr virNetworkCreateXML (virConnectPtr conn, * Define inactive persistent network */ virNetworkPtr virNetworkDefineXML (virConnectPtr conn, - const char *xmlDesc); + const char *xml); /* * Delete persistent network diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-nwfilter.h index 9f01c175a..c72a676ce 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -62,7 +62,7 @@ virNWFilterPtr virNWFilterLookupByName (virConnectPtr conn, virNWFilterPtr virNWFilterLookupByUUID (virConnectPtr conn, const unsigned char *uuid); virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn, - const char *uuid); + const char *uuidstr); /* * Define persistent nwfilter diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index 2bb8ee868..f7db72ef7 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -40,7 +40,7 @@ typedef enum { int virDomainQemuMonitorCommand(virDomainPtr domain, const char *cmd, char **result, unsigned int flags); -virDomainPtr virDomainQemuAttach(virConnectPtr domain, +virDomainPtr virDomainQemuAttach(virConnectPtr conn, unsigned int pid_value, unsigned int flags); diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-secret.h index 5df0b8ff8..bce58d051 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -84,7 +84,7 @@ int virConnectListAllSecrets(virConnectPtr conn, virSecretPtr virSecretLookupByUUID(virConnectPtr conn, const unsigned char *uuid); virSecretPtr virSecretLookupByUUIDString(virConnectPtr conn, - const char *uuid); + const char *uuidstr); virSecretPtr virSecretLookupByUsage(virConnectPtr conn, int usageType, const char *usageID); @@ -92,7 +92,7 @@ virSecretPtr virSecretDefineXML (virConnectPtr conn, const char *xml, unsigned int flags); int virSecretGetUUID (virSecretPtr secret, - unsigned char *buf); + unsigned char *uuid); int virSecretGetUUIDString (virSecretPtr secret, char *buf); int virSecretGetUsageType (virSecretPtr secret); diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-storage.h index 413d9f6c4..f3209fb8b 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -262,7 +262,7 @@ virStoragePoolPtr virStoragePoolLookupByName (virConnectPtr conn, virStoragePoolPtr virStoragePoolLookupByUUID (virConnectPtr conn, const unsigned char *uuid); virStoragePoolPtr virStoragePoolLookupByUUIDString(virConnectPtr conn, - const char *uuid); + const char *uuidstr); virStoragePoolPtr virStoragePoolLookupByVolume (virStorageVolPtr vol); virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr conn, const char *path); @@ -274,7 +274,7 @@ virStoragePoolPtr virStoragePoolCreateXML (virConnectPtr conn, const char *xmlDesc, unsigned int flags); virStoragePoolPtr virStoragePoolDefineXML (virConnectPtr conn, - const char *xmlDesc, + const char *xml, unsigned int flags); int virStoragePoolBuild (virStoragePoolPtr pool, unsigned int flags); @@ -298,7 +298,7 @@ int virStoragePoolGetUUID (virStoragePoolPtr pool, int virStoragePoolGetUUIDString (virStoragePoolPtr pool, char *buf); -int virStoragePoolGetInfo (virStoragePoolPtr vol, +int virStoragePoolGetInfo (virStoragePoolPtr pool, virStoragePoolInfoPtr info); char * virStoragePoolGetXMLDesc (virStoragePoolPtr pool, @@ -342,10 +342,10 @@ typedef enum { } virStorageVolCreateFlags; virStorageVolPtr virStorageVolCreateXML (virStoragePoolPtr pool, - const char *xmldesc, + const char *xmlDesc, unsigned int flags); virStorageVolPtr virStorageVolCreateXMLFrom (virStoragePoolPtr pool, - const char *xmldesc, + const char *xmlDesc, virStorageVolPtr clonevol, unsigned int flags); @@ -382,7 +382,7 @@ int virStorageVolGetInfo (virStorageVolPtr vol, int virStorageVolGetInfoFlags (virStorageVolPtr vol, virStorageVolInfoPtr info, unsigned int flags); -char * virStorageVolGetXMLDesc (virStorageVolPtr pool, +char * virStorageVolGetXMLDesc (virStorageVolPtr vol, unsigned int flags); char * virStorageVolGetPath (virStorageVolPtr vol); diff --git a/include/libvirt/libvirt-stream.h b/include/libvirt/libvirt-stream.h index 86f96b158..c861c5658 100644 --- a/include/libvirt/libvirt-stream.h +++ b/include/libvirt/libvirt-stream.h @@ -35,13 +35,13 @@ typedef enum { virStreamPtr virStreamNew(virConnectPtr conn, unsigned int flags); -int virStreamRef(virStreamPtr st); +int virStreamRef(virStreamPtr stream); -int virStreamSend(virStreamPtr st, +int virStreamSend(virStreamPtr stream, const char *data, size_t nbytes); -int virStreamRecv(virStreamPtr st, +int virStreamRecv(virStreamPtr stream, char *data, size_t nbytes); @@ -49,12 +49,12 @@ typedef enum { VIR_STREAM_RECV_STOP_AT_HOLE = (1 << 0), } virStreamRecvFlagsValues; -int virStreamRecvFlags(virStreamPtr st, +int virStreamRecvFlags(virStreamPtr stream, char *data, size_t nbytes, unsigned int flags); -int virStreamSendHole(virStreamPtr st, +int virStreamSendHole(virStreamPtr stream, long long length, unsigned int flags); @@ -95,7 +95,7 @@ typedef int (*virStreamSourceFunc)(virStreamPtr st, size_t nbytes, void *opaque); -int virStreamSendAll(virStreamPtr st, +int virStreamSendAll(virStreamPtr stream, virStreamSourceFunc handler, void *opaque); @@ -158,7 +158,7 @@ typedef int (*virStreamSourceSkipFunc)(virStreamPtr st, long long length, void *opaque); -int virStreamSparseSendAll(virStreamPtr st, +int virStreamSparseSendAll(virStreamPtr stream, virStreamSourceFunc handler, virStreamSourceHoleFunc holeHandler, virStreamSourceSkipFunc skipHandler, @@ -196,7 +196,7 @@ typedef int (*virStreamSinkFunc)(virStreamPtr st, size_t nbytes, void *opaque); -int virStreamRecvAll(virStreamPtr st, +int virStreamRecvAll(virStreamPtr stream, virStreamSinkFunc handler, void *opaque); @@ -262,9 +262,9 @@ int virStreamEventUpdateCallback(virStreamPtr stream, int virStreamEventRemoveCallback(virStreamPtr stream); -int virStreamFinish(virStreamPtr st); -int virStreamAbort(virStreamPtr st); +int virStreamFinish(virStreamPtr stream); +int virStreamAbort(virStreamPtr stream); -int virStreamFree(virStreamPtr st); +int virStreamFree(virStreamPtr stream); #endif /* __VIR_LIBVIRT_STREAM_H__ */ -- 2.14.1
On Mon, Feb 12, 2018 at 12:20:55PM -0600, Chris Venteicher wrote:
Headers use same function parameter names as definition code. --- include/libvirt/libvirt-domain.h | 26 +++++++++++++------------- include/libvirt/libvirt-event.h | 4 ++-- include/libvirt/libvirt-host.h | 4 ++-- include/libvirt/libvirt-interface.h | 4 ++-- include/libvirt/libvirt-network.h | 6 +++--- include/libvirt/libvirt-nwfilter.h | 2 +- include/libvirt/libvirt-qemu.h | 2 +- include/libvirt/libvirt-secret.h | 4 ++-- include/libvirt/libvirt-storage.h | 12 ++++++------ include/libvirt/libvirt-stream.h | 22 +++++++++++----------- 10 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 4048acf38..60ec35d87 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h
@@ -1161,11 +1161,11 @@ int virDomainFree (virDomainPtr domain); */ int virDomainSuspend (virDomainPtr domain); int virDomainResume (virDomainPtr domain); -int virDomainPMSuspendForDuration (virDomainPtr domain, +int virDomainPMSuspendForDuration (virDomainPtr dom,
This changes domain -> dom , but then....
-int virDomainSetInterfaceParameters (virDomainPtr dom, +int virDomainSetInterfaceParameters (virDomainPtr domain,
This changes dom -> domain. IMHO this is no better than we started with. We should aim for consistency naming, so rather than only changing the .h, we should change .c and .h to match preferred naming. Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On Mon, Feb 12, 2018 at 06:35:45PM +0000, Daniel P. Berrangé wrote:
On Mon, Feb 12, 2018 at 12:20:55PM -0600, Chris Venteicher wrote:
Headers use same function parameter names as definition code. --- include/libvirt/libvirt-domain.h | 26 +++++++++++++------------- include/libvirt/libvirt-event.h | 4 ++-- include/libvirt/libvirt-host.h | 4 ++-- include/libvirt/libvirt-interface.h | 4 ++-- include/libvirt/libvirt-network.h | 6 +++--- include/libvirt/libvirt-nwfilter.h | 2 +- include/libvirt/libvirt-qemu.h | 2 +- include/libvirt/libvirt-secret.h | 4 ++-- include/libvirt/libvirt-storage.h | 12 ++++++------ include/libvirt/libvirt-stream.h | 22 +++++++++++----------- 10 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h index 4048acf38..60ec35d87 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h
@@ -1161,11 +1161,11 @@ int virDomainFree (virDomainPtr domain); */ int virDomainSuspend (virDomainPtr domain); int virDomainResume (virDomainPtr domain); -int virDomainPMSuspendForDuration (virDomainPtr domain, +int virDomainPMSuspendForDuration (virDomainPtr dom,
This changes domain -> dom , but then....
-int virDomainSetInterfaceParameters (virDomainPtr dom, +int virDomainSetInterfaceParameters (virDomainPtr domain,
This changes dom -> domain.
IMHO this is no better than we started with. We should aim for consistency naming, so rather than only changing the .h, we should change .c and .h to match preferred naming.
For that matter, we should add a custom syntx-check rule to cfg.mak to validate the variable naming for various data types. ie validate that virDomainPtr is always "dom", not "domain". virNetworkPtr is "net" not "network", etc Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
participants (2)
-
Chris Venteicher -
Daniel P. Berrangé