Mailing List Archive

Re: [PATCH 2/2] Remove leading underscores from Xen defines
On 05/06/2021 19.50, Ahmed Abouzied wrote:
> Identifiers with leading underscores followed by capital letters or
> underscores are reserved for C standards.
>
> Resolves: https://gitlab.com/qemu-project/qemu/-/issues/369
>
> Signed-off-by: Ahmed Abouzied <email@aabouzied.com>
> ---
> include/hw/xen/interface/grant_table.h | 4 ++--
> include/hw/xen/interface/io/blkif.h | 4 ++--
> include/hw/xen/interface/io/console.h | 4 ++--
> include/hw/xen/interface/io/fbif.h | 4 ++--
> include/hw/xen/interface/io/kbdif.h | 4 ++--
> include/hw/xen/interface/io/netif.h | 4 ++--
> include/hw/xen/interface/io/protocols.h | 4 ++--
> include/hw/xen/interface/io/ring.h | 4 ++--
> include/hw/xen/interface/io/usbif.h | 4 ++--
> 9 files changed, 18 insertions(+), 18 deletions(-)
>
> diff --git a/include/hw/xen/interface/grant_table.h b/include/hw/xen/interface/grant_table.h
> index 2af0cbdde3..c0a09dadad 100644
> --- a/include/hw/xen/interface/grant_table.h
> +++ b/include/hw/xen/interface/grant_table.h
> @@ -25,8 +25,8 @@
> * Copyright (c) 2004, K A Fraser
> */
>
> -#ifndef __XEN_PUBLIC_GRANT_TABLE_H__
> -#define __XEN_PUBLIC_GRANT_TABLE_H__
> +#ifndef XEN_PUBLIC_GRANT_TABLE_H
> +#define XEN_PUBLIC_GRANT_TABLE_H
>
> /*
> * Reference to a grant entry in a specified domain's grant table.
> diff --git a/include/hw/xen/interface/io/blkif.h b/include/hw/xen/interface/io/blkif.h
> index d07fa1e078..680914571f 100644
> --- a/include/hw/xen/interface/io/blkif.h
> +++ b/include/hw/xen/interface/io/blkif.h
> @@ -25,8 +25,8 @@
> * Copyright (c) 2012, Spectra Logic Corporation
> */
>
> -#ifndef __XEN_PUBLIC_IO_BLKIF_H__
> -#define __XEN_PUBLIC_IO_BLKIF_H__
> +#ifndef XEN_PUBLIC_IO_BLKIF_H
> +#define XEN_PUBLIC_IO_BLKIF_H
>
> #include "ring.h"
> #include "../grant_table.h"
> diff --git a/include/hw/xen/interface/io/console.h b/include/hw/xen/interface/io/console.h
> index e2155d1cf5..0d4a72456e 100644
> --- a/include/hw/xen/interface/io/console.h
> +++ b/include/hw/xen/interface/io/console.h
> @@ -24,8 +24,8 @@
> * Copyright (c) 2005, Keir Fraser
> */
>
> -#ifndef __XEN_PUBLIC_IO_CONSOLE_H__
> -#define __XEN_PUBLIC_IO_CONSOLE_H__
> +#ifndef XEN_PUBLIC_IO_CONSOLE_H
> +#define XEN_PUBLIC_IO_CONSOLE_H
>
> typedef uint32_t XENCONS_RING_IDX;
>
> diff --git a/include/hw/xen/interface/io/fbif.h b/include/hw/xen/interface/io/fbif.h
> index ea87ebec0a..4e25423490 100644
> --- a/include/hw/xen/interface/io/fbif.h
> +++ b/include/hw/xen/interface/io/fbif.h
> @@ -23,8 +23,8 @@
> * Copyright (C) 2006 Red Hat, Inc., Markus Armbruster <armbru@redhat.com>
> */
>
> -#ifndef __XEN_PUBLIC_IO_FBIF_H__
> -#define __XEN_PUBLIC_IO_FBIF_H__
> +#ifndef XEN_PUBLIC_IO_FBIF_H
> +#define XEN_PUBLIC_IO_FBIF_H
>
> /* Out events (frontend -> backend) */
>
> diff --git a/include/hw/xen/interface/io/kbdif.h b/include/hw/xen/interface/io/kbdif.h
> index 1d68cd458e..a952c77bf2 100644
> --- a/include/hw/xen/interface/io/kbdif.h
> +++ b/include/hw/xen/interface/io/kbdif.h
> @@ -23,8 +23,8 @@
> * Copyright (C) 2006 Red Hat, Inc., Markus Armbruster <armbru@redhat.com>
> */
>
> -#ifndef __XEN_PUBLIC_IO_KBDIF_H__
> -#define __XEN_PUBLIC_IO_KBDIF_H__
> +#ifndef XEN_PUBLIC_IO_KBDIF_H
> +#define XEN_PUBLIC_IO_KBDIF_H
>
> /*
> *****************************************************************************
> diff --git a/include/hw/xen/interface/io/netif.h b/include/hw/xen/interface/io/netif.h
> index 48fa530950..f4a28a43b1 100644
> --- a/include/hw/xen/interface/io/netif.h
> +++ b/include/hw/xen/interface/io/netif.h
> @@ -24,8 +24,8 @@
> * Copyright (c) 2003-2004, Keir Fraser
> */
>
> -#ifndef __XEN_PUBLIC_IO_NETIF_H__
> -#define __XEN_PUBLIC_IO_NETIF_H__
> +#ifndef XEN_PUBLIC_IO_NETIF_H
> +#define XEN_PUBLIC_IO_NETIF_H
>
> #include "ring.h"
> #include "../grant_table.h"
> diff --git a/include/hw/xen/interface/io/protocols.h b/include/hw/xen/interface/io/protocols.h
> index 52b4de0f81..3d1cac322b 100644
> --- a/include/hw/xen/interface/io/protocols.h
> +++ b/include/hw/xen/interface/io/protocols.h
> @@ -22,8 +22,8 @@
> * Copyright (c) 2008, Keir Fraser
> */
>
> -#ifndef __XEN_PROTOCOLS_H__
> -#define __XEN_PROTOCOLS_H__
> +#ifndef XEN_PROTOCOLS_H
> +#define XEN_PROTOCOLS_H
>
> #define XEN_IO_PROTO_ABI_X86_32 "x86_32-abi"
> #define XEN_IO_PROTO_ABI_X86_64 "x86_64-abi"
> diff --git a/include/hw/xen/interface/io/ring.h b/include/hw/xen/interface/io/ring.h
> index 115705f3f4..ea324c5a62 100644
> --- a/include/hw/xen/interface/io/ring.h
> +++ b/include/hw/xen/interface/io/ring.h
> @@ -24,8 +24,8 @@
> * Tim Deegan and Andrew Warfield November 2004.
> */
>
> -#ifndef __XEN_PUBLIC_IO_RING_H__
> -#define __XEN_PUBLIC_IO_RING_H__
> +#ifndef XEN_PUBLIC_IO_RING_H
> +#define XEN_PUBLIC_IO_RING_H
>
> /*
> * When #include'ing this header, you need to provide the following
> diff --git a/include/hw/xen/interface/io/usbif.h b/include/hw/xen/interface/io/usbif.h
> index c6a58639d6..564c0115e8 100644
> --- a/include/hw/xen/interface/io/usbif.h
> +++ b/include/hw/xen/interface/io/usbif.h
> @@ -25,8 +25,8 @@
> * DEALINGS IN THE SOFTWARE.
> */
>
> -#ifndef __XEN_PUBLIC_IO_USBIF_H__
> -#define __XEN_PUBLIC_IO_USBIF_H__
> +#ifndef XEN_PUBLIC_IO_USBIF_H
> +#define XEN_PUBLIC_IO_USBIF_H
>
> #include "ring.h"
> #include "../grant_table.h"
>

I hope the Xen people can comment on whether the underscores had a purpose
here or whether it's ok to remove them, thus:

Cc: xen-devel@lists.xenproject.org

From my QEMU-developer's side of view:

Reviewed-by: Thomas Huth <thuth@redhat.com>
Re: [PATCH 2/2] Remove leading underscores from Xen defines [ In reply to ]
On Mon, Jun 07, 2021 at 08:36:07AM +0200, Thomas Huth wrote:
> On 05/06/2021 19.50, Ahmed Abouzied wrote:
> > Identifiers with leading underscores followed by capital letters or
> > underscores are reserved for C standards.
> >
> > Resolves: https://gitlab.com/qemu-project/qemu/-/issues/369
> >
> > Signed-off-by: Ahmed Abouzied <email@aabouzied.com>
> > ---
> > include/hw/xen/interface/grant_table.h | 4 ++--
> > include/hw/xen/interface/io/blkif.h | 4 ++--
> > include/hw/xen/interface/io/console.h | 4 ++--
> > include/hw/xen/interface/io/fbif.h | 4 ++--
> > include/hw/xen/interface/io/kbdif.h | 4 ++--
> > include/hw/xen/interface/io/netif.h | 4 ++--
> > include/hw/xen/interface/io/protocols.h | 4 ++--
> > include/hw/xen/interface/io/ring.h | 4 ++--
> > include/hw/xen/interface/io/usbif.h | 4 ++--
> > 9 files changed, 18 insertions(+), 18 deletions(-)
> >
>
> I hope the Xen people can comment on whether the underscores had a purpose
> here or whether it's ok to remove them, thus:
>
> Cc: xen-devel@lists.xenproject.org
>
> From my QEMU-developer's side of view:
>
> Reviewed-by: Thomas Huth <thuth@redhat.com>
>

Nacked-by: Anthony PERARD <anthony.perard@citrix.com>

Please don't change the header guards in include/hw/xen/interface/.
This have been attempted before and result in build failures, see
d1744bd3218daa820744c14572058491e4854399 (Revert xen/io/ring.h of "Clean up a few header guard symbols")

Cheers,

--
Anthony PERARD