[Qemu-devel] [RFC] HACKING: Document 'struct' keyword usage

[Eduardo Habkost]

Sometimes we use the 'struct' keyword to help us reduce
dependencies between header files.  Document that practice.

Signed-off-by: Eduardo Habkost <address@hidden>
---
I wonder if this is too terse?  Should we give examples?
---
 HACKING | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/HACKING b/HACKING
index 0fc3e0fc04..112685bdaf 100644
--- a/HACKING
+++ b/HACKING
@@ -101,6 +101,8 @@ it points to, or it is aliased to another pointer that is.
 
 2.3. Typedefs
 Typedefs are used to eliminate the redundant 'struct' keyword.
+However, the 'struct' keyword may be sometimes used in header
+files to avoid unnecessary dependencies between headers.
 
 2.4. Reserved namespaces in C and POSIX
 Underscore capital, double underscore, and underscore 't' suffixes should be
-- 
2.21.0