[PATCH] monitor/qmp-cmds.c: Don't include ui/vnc.h

[PATCH] monitor/qmp-cmds.c: Don't include ui/vnc.h

[Peter Maydell]

The qmp-cmds.c file currently includes ui/vnc.h, which (being located
in the ui/ directory rather than include) is really supposed to be
for use only by the ui subsystem.  In fact the function prototypes we
need (vnc_display_password(), etc) are all declared in
include/ui/console.h, so we can switch to including that instead.

(ui/vnc.h includes include/ui/console.h, so this change strictly
reduces the quantity of headers qmp-cmds.c pulls in.)

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Spotted while trying to reduce the number of source files that
indirectly include <gnutls.h>...
---
 monitor/qmp-cmds.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/monitor/qmp-cmds.c b/monitor/qmp-cmds.c
index 34f7e75b7bf..c95e5001d72 100644
--- a/monitor/qmp-cmds.c
+++ b/monitor/qmp-cmds.c
@@ -23,7 +23,7 @@
 #include "qemu/uuid.h"
 #include "chardev/char.h"
 #include "ui/qemu-spice.h"
-#include "ui/vnc.h"
+#include "ui/console.h"
 #include "sysemu/kvm.h"
 #include "sysemu/runstate.h"
 #include "sysemu/runstate-action.h"
-- 
2.20.1

Re: [PATCH] monitor/qmp-cmds.c: Don't include ui/vnc.h

[Philippe Mathieu-Daudé]

On 1/4/21 5:12 PM, Peter Maydell wrote:
> The qmp-cmds.c file currently includes ui/vnc.h, which (being located
> in the ui/ directory rather than include) is really supposed to be
> for use only by the ui subsystem.

That makes me remember yet another cleanup series I started few months
ago to remove -I$(srcdir) from $CFLAGS. Now that Meson is in, I might
eventually refresh it.

> In fact the function prototypes we
> need (vnc_display_password(), etc) are all declared in
> include/ui/console.h, so we can switch to including that instead.
> 
> (ui/vnc.h includes include/ui/console.h, so this change strictly
> reduces the quantity of headers qmp-cmds.c pulls in.)
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

> ---
> Spotted while trying to reduce the number of source files that
> indirectly include <gnutls.h>...
> ---
>  monitor/qmp-cmds.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/monitor/qmp-cmds.c b/monitor/qmp-cmds.c
> index 34f7e75b7bf..c95e5001d72 100644
> --- a/monitor/qmp-cmds.c
> +++ b/monitor/qmp-cmds.c
> @@ -23,7 +23,7 @@
>  #include "qemu/uuid.h"
>  #include "chardev/char.h"
>  #include "ui/qemu-spice.h"
> -#include "ui/vnc.h"
> +#include "ui/console.h"
>  #include "sysemu/kvm.h"
>  #include "sysemu/runstate.h"
>  #include "sysemu/runstate-action.h"
> 

Re: [PATCH] monitor/qmp-cmds.c: Don't include ui/vnc.h

[Peter Maydell]

On Mon, 4 Jan 2021 at 16:30, Philippe Mathieu-Daudé <philmd@redhat.com> wrote:
>
> On 1/4/21 5:12 PM, Peter Maydell wrote:
> > The qmp-cmds.c file currently includes ui/vnc.h, which (being located
> > in the ui/ directory rather than include) is really supposed to be
> > for use only by the ui subsystem.
>
> That makes me remember yet another cleanup series I started few months
> ago to remove -I$(srcdir) from $CFLAGS. Now that Meson is in, I might
> eventually refresh it.

Yeah, I just floated that idea on IRC. I bet we have a ton of
places that don't follow the "headers not in include/ are supposed
to be subsystem-internal" guideline, though, so it feels like one
of those "whether it's worth the effort depends on how painful it is"
cleanups...

thanks
-- PMM

Re: [PATCH] monitor/qmp-cmds.c: Don't include ui/vnc.h

[Markus Armbruster]

Peter Maydell <peter.maydell@linaro.org> writes:

> The qmp-cmds.c file currently includes ui/vnc.h, which (being located
> in the ui/ directory rather than include) is really supposed to be
> for use only by the ui subsystem.  In fact the function prototypes we
> need (vnc_display_password(), etc) are all declared in
> include/ui/console.h, so we can switch to including that instead.
>
> (ui/vnc.h includes include/ui/console.h, so this change strictly
> reduces the quantity of headers qmp-cmds.c pulls in.)
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Almost missed this one.  Queued, thanks!