syntax-check: Only allows to include public headers in external tools

With this patch, include public headers in "" form is only allowed
for "internal.h". And only the external tools (examples|tools|python
|include/libvirt) can include the public headers in <> form.

diff --git a/cfg.mk b/cfg.mk
index 5f422de21ae43a7e01728dd68efcaf5ac562632e..ebb6613d9f638d22670cd677ca942c0ee567ad0b 100644 (file)
--- a/cfg.mk
+++ b/cfg.mk
@@ -747,9 +747,17 @@ sc_prohibit_duplicate_header:
        fi;
 
 # Don't include "libvirt/*.h" in "" form.
-sc_prohibit_include_public_headers:
+sc_prohibit_include_public_headers_quote:
        @prohibit='# *include *"libvirt/.*\.h"'                         \
-       in_vc_files='\.[chx]$$'                                         \
+       in_vc_files='\.[ch]$$'                                          \
+       halt='Do not include libvirt/*.h in internal source'            \
+         $(_sc_search_regexp)
+
+# Don't include "libvirt/*.h" in <> form. Except for external tools,
+# e.g. Python binding, examples and tools subdirectories.
+sc_prohibit_include_public_headers_brackets:
+       @prohibit='# *include *<libvirt/.*\.h>'                         \
+       in_vc_files='\.[ch]$$'                                          \
        halt='Do not include libvirt/*.h in internal source'            \
          $(_sc_search_regexp)
 
@@ -907,5 +915,8 @@ exclude_file_name_regexp--sc_correct_id_types = \
 
 exclude_file_name_regexp--sc_m4_quote_check = m4/virt-lib.m4
 
-exclude_file_name_regexp--sc_prohibit_include_public_headers = \
-  ^(src/internal\.h$$|python/|tools/|examples/|include/libvirt/libvirt-(qemu|lxc)\.h$$)
+exclude_file_name_regexp--sc_prohibit_include_public_headers_quote = \
+  ^src/internal\.h$$
+
+exclude_file_name_regexp--sc_prohibit_include_public_headers_brackets = \
+  ^(python/|tools/|examples/|include/libvirt/(virterror|libvirt-(qemu|lxc))\.h$$)

diff --git a/include/libvirt/libvirt-lxc.h b/include/libvirt/libvirt-lxc.h
index 50218137b0c4262a7ff776c38ff2a63f764c255d..1901fce4f8d372d611316a7c4a8d6a67a655a3d9 100644 (file)
--- a/include/libvirt/libvirt-lxc.h
+++ b/include/libvirt/libvirt-lxc.h
@@ -26,7 +26,7 @@
 #ifndef __VIR_LXC_H__
 # define __VIR_LXC_H__
 
-# include "libvirt/libvirt.h"
+# include <libvirt/libvirt.h>
 
 # ifdef __cplusplus
 extern "C" {

diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h
index 8ec12b4dffa4c23fa6ceee5fa5c27dde213cd724..3e79a8ccfa39538e2d9e78f41bc126b6b8b95c4a 100644 (file)
--- a/include/libvirt/libvirt-qemu.h
+++ b/include/libvirt/libvirt-qemu.h
@@ -26,7 +26,7 @@
 #ifndef __VIR_QEMU_H__
 # define __VIR_QEMU_H__
 
-# include "libvirt/libvirt.h"
+# include <libvirt/libvirt.h>
 
 # ifdef __cplusplus
 extern "C" {

diff --git a/python/libvirt-lxc-override.c b/python/libvirt-lxc-override.c
index c80668ef4552ddb527267d6701a63915198c3408..ead175f2501edbebd052d4e8c5361b04c0294f38 100644 (file)
--- a/python/libvirt-lxc-override.c
+++ b/python/libvirt-lxc-override.c
@@ -17,8 +17,8 @@
 #undef HAVE_PTHREAD_H
 
 #include <Python.h>
-#include "libvirt/libvirt-lxc.h"
-#include "libvirt/virterror.h"
+#include <libvirt/libvirt-lxc.h>
+#include <libvirt/virterror.h>
 #include "typewrappers.h"
 #include "libvirt-lxc.h"
 #include "viralloc.h"

diff --git a/python/libvirt-override.c b/python/libvirt-override.c
index f6573e1afcf8818862f78a8a3fbd6f33f999936f..3d8490c0721e7bbb0ceb734c2ea8ef3601a515d5 100644 (file)
--- a/python/libvirt-override.c
+++ b/python/libvirt-override.c
@@ -20,8 +20,8 @@
 #define VIR_ENUM_SENTINELS
 
 #include <Python.h>
-#include "libvirt/libvirt.h"
-#include "libvirt/virterror.h"
+#include <libvirt/libvirt.h>
+#include <libvirt/virterror.h>
 #include "typewrappers.h"
 #include "libvirt.h"
 #include "viralloc.h"

diff --git a/python/libvirt-qemu-override.c b/python/libvirt-qemu-override.c
index 243692a0fb29c9b3e9c1fd2b18068a34cdd6921f..8f1ce5e99b98cd11d457d908a9767488311f5322 100644 (file)
--- a/python/libvirt-qemu-override.c
+++ b/python/libvirt-qemu-override.c
@@ -17,8 +17,8 @@
 #undef HAVE_PTHREAD_H
 
 #include <Python.h>
-#include "libvirt/libvirt-qemu.h"
-#include "libvirt/virterror.h"
+#include <libvirt/libvirt-qemu.h>
+#include <libvirt/virterror.h>
 #include "typewrappers.h"
 #include "libvirt-qemu.h"
 

diff --git a/python/typewrappers.h b/python/typewrappers.h
index af68bcede57ed0a7139d659159e73a9cc2a9f5d2..d871d3fcc7a8f43d4b4fd9ed5fdb4f5ed8efe4dd 100644 (file)
--- a/python/typewrappers.h
+++ b/python/typewrappers.h
@@ -8,8 +8,8 @@
 
 #include <Python.h>
 #include <stdbool.h>
-#include "libvirt/libvirt.h"
-#include "libvirt/virterror.h"
+#include <libvirt/libvirt.h>
+#include <libvirt/virterror.h>
 
 #ifdef __GNUC__
 # ifdef ATTRIBUTE_UNUSED

diff --git a/tests/shunloadhelper.c b/tests/shunloadhelper.c
index 1b025ee539c7dfda88bb9194df2070ae284e255c..a8f5aef4e9d44e0d8bd3a6542982698a96ea1258 100644 (file)
--- a/tests/shunloadhelper.c
+++ b/tests/shunloadhelper.c
@@ -26,12 +26,11 @@
  */
 
 #include <config.h>
-#include "internal.h"
 
-#include <libvirt/libvirt.h>
-#include <libvirt/virterror.h>
 #include <stdlib.h>
 
+#include "internal.h"
+
 static void shunloadError(void *userData ATTRIBUTE_UNUSED,
                           virErrorPtr error ATTRIBUTE_UNUSED)
 {

diff --git a/tools/virsh.c b/tools/virsh.c
index b7a5cc1f27c75cc8012680169be68739ce919d23..4cd93ca717c30cad5473270d01a79db2b24364d3 100644 (file)
--- a/tools/virsh.c
+++ b/tools/virsh.c
@@ -60,8 +60,8 @@
 #include "virutil.h"
 #include "viralloc.h"
 #include "virxml.h"
-#include "libvirt/libvirt-qemu.h"
-#include "libvirt/libvirt-lxc.h"
+#include <libvirt/libvirt-qemu.h>
+#include <libvirt/libvirt-lxc.h>
 #include "virfile.h"
 #include "configmake.h"
 #include "virthread.h"