On 18/04/13 04:25, Eric Blake wrote:
On 04/17/2013 04:19 AM, Osier Yang wrote:
To tell libvirt-{qemu,lxc}.h shouldn't be included either. --- docs/hacking.html.in | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) You also need to run 'make HACKING' and check that in at the same time. (Yes, that's one of the few generated files we actually version control).
diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 7ef826c..67af5c2 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -929,10 +929,10 @@ </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, and libvirt/libvirt-lxc.h. s/and/or/
+ It is included by "internal.h" already and there are some special reasons s/It is/They are/
+ why you cannot include these files explicitly. Is it worth mentioning the visibility of *_LAST enums as one of these reasons?
It's actually an exception (special case), not a reason. But good to list it here. I added it like: One of special cases, "libvirt/libvirt.h" is included prior to "internal.h" in "remote_protocol.x", to avoid exposing *_LAST enum elements.
ACK with the grammar fix and generated file; up to you whether to further document the "why".