openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Update HACKING 

To tell libvirt-{qemu,lxc}.h shouldn't be included either.
This commit is contained in:
Osier Yang 2013-04-17 18:19:20 +08:00
parent 9969ade669
commit 06902a6f18
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
HACKING
View File

@ -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. Of particular note: *Do not* include libvirt/libvirt.h, libvirt/virterror.h,
It is included by "internal.h" already and there are some special reasons why libvirt/libvirt-qemu.h, or libvirt/libvirt-lxc.h. They are included by
you cannot include these files explicitly. "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 Printf-style functions

10
docs/hacking.html.in
View File

@ -929,10 +929,12 @@
</pre> </pre>
<p> <p>
Of particular note: <b>Do not</b> include libvirt/libvirt.h or Of particular note: <b>Do not</b> include libvirt/libvirt.h,
libvirt/virterror.h. It is included by "internal.h" already and there libvirt/virterror.h, libvirt/libvirt-qemu.h, or libvirt/libvirt-lxc.h.
are some special reasons why you cannot include these files They are included by "internal.h" already and there are some special reasons
explicitly. 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> </p>