Markus Armbruster <arm...@redhat.com> writes:
> Rules for headers were proposed a long time ago, and generally liked: > > Message-ID: <87h9g8j57d....@blackfin.pond.sub.org> > https://lists.nongnu.org/archive/html/qemu-devel/2016-03/msg03345.html > > Wortk them into docs/devel/style.rst. nit: spelling Work > > Suggested-by: Bernhard Beschow <shen...@gmail.com> > Signed-off-by: Markus Armbruster <arm...@redhat.com> Reviewed-by: Alex Bennée <alex.ben...@linaro.org> > --- > docs/devel/style.rst | 7 +++++++ > 1 file changed, 7 insertions(+) > > diff --git a/docs/devel/style.rst b/docs/devel/style.rst > index 7ddd42b6c2..68aa776930 100644 > --- a/docs/devel/style.rst > +++ b/docs/devel/style.rst > @@ -293,6 +293,13 @@ that QEMU depends on. > Do not include "qemu/osdep.h" from header files since the .c file will have > already included it. > > +Headers should normally include everything they need beyond osdep.h. > +If exceptions are needed for some reason, they must be documented in > +the header. If all that's needed from a header is typedefs, consider > +putting those into qemu/typedefs.h instead of including the header. > + > +Cyclic inclusion is forbidden. > + > C types > ======= -- Alex Bennée Virtualisation Tech Lead @ Linaro