From 06902a6f18224e4aaeec79d7f0b6e58b17fcccd7 Mon Sep 17 00:00:00 2001 From: Osier Yang Date: Wed, 17 Apr 2013 18:19:20 +0800 Subject: [PATCH] docs: Update HACKING To tell libvirt-{qemu,lxc}.h shouldn't be included either. --- HACKING | 9 ++++++--- docs/hacking.html.in | 10 ++++++---- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/HACKING b/HACKING index c8833c0bc9..a648d54fe4 100644 --- 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 7ef826c726..632d357a4e 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -929,10 +929,12 @@

- 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.