docs: Update HACKING

To tell libvirt-{qemu,lxc}.h shouldn't be included either.

diff --git a/HACKING b/HACKING
index c8833c0bc9e01c2671832245984bc6dda7cafec8..a648d54fe4110a9dea51470e65856f9d1dcc4b9c 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -786,9 +786,12 @@ stick to the following general plan for all *.c source files:
   {
       ...
 
-Of particular note: *Do not* include libvirt/libvirt.h or libvirt/virterror.h.
-It is included by "internal.h" already and there are some special reasons why
-you cannot include these files explicitly.
+Of particular note: *Do not* include libvirt/libvirt.h, libvirt/virterror.h,
+libvirt/libvirt-qemu.h, or libvirt/libvirt-lxc.h. They are included by
+"internal.h" already and there are some special reasons why you cannot include
+these files explicitly. One of the special cases, "libvirt/libvirt.h" is
+included prior to "internal.h" in "remote_protocol.x", to avoid exposing
+*_LAST enum elements.
 
 
 Printf-style functions

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 7ef826c726268d9f5a28e11e1c1871e319faa4b6..632d357a4e753bf18182dbc94f6b69d859e34196 100644 (file)
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -929,10 +929,12 @@
 </pre>
 
     <p>
-      Of particular note: <b>Do not</b> include libvirt/libvirt.h or
-      libvirt/virterror.h.  It is included by "internal.h" already and there
-      are some special reasons why you cannot include these files
-      explicitly.
+      Of particular note: <b>Do not</b> include libvirt/libvirt.h,
+      libvirt/virterror.h, libvirt/libvirt-qemu.h, or libvirt/libvirt-lxc.h.
+      They are included by "internal.h" already and there are some special reasons
+      why you cannot include these files explicitly. One of the special cases,
+      "libvirt/libvirt.h" is included prior to "internal.h" in "remote_protocol.x",
+      to avoid exposing *_LAST enum elements.
     </p>