ec150c7e09
Back in 2016, we discussed[1] rules for headers, and these were
generally liked:
1. Have a carefully curated header that's included everywhere first. We
got that already thanks to Peter: osdep.h.
2. 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, put
those into qemu/typedefs.h instead of including the header.
3. Cyclic inclusion is forbidden.
This patch gets include/ closer to obeying 2.
It's actually extracted from my "[RFC] Baby steps towards saner
headers" series[2], which demonstrates a possible path towards
checking 2 automatically. It passes the RFC test there.
[1] Message-ID: <87h9g8j57d.fsf@blackfin.pond.sub.org>
https://lists.nongnu.org/archive/html/qemu-devel/2016-03/msg03345.html
[2] Message-Id: <20190711122827.18970-1-armbru@redhat.com>
https://lists.nongnu.org/archive/html/qemu-devel/2019-07/msg02715.html
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-Id: <20190812052359.30071-2-armbru@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
|
||
|---|---|---|
| .. | ||
| a9gtimer.h | ||
| allwinner-a10-pit.h | ||
| arm_mptimer.h | ||
| armv7m_systick.h | ||
| aspeed_rtc.h | ||
| aspeed_timer.h | ||
| cmsdk-apb-dualtimer.h | ||
| cmsdk-apb-timer.h | ||
| digic-timer.h | ||
| hpet.h | ||
| i8254.h | ||
| i8254_internal.h | ||
| imx_epit.h | ||
| imx_gpt.h | ||
| m48t59.h | ||
| mc146818rtc.h | ||
| mc146818rtc_regs.h | ||
| mips_gictimer.h | ||
| mss-timer.h | ||
| nrf51_timer.h | ||
| pl031.h | ||
| stm32f2xx_timer.h | ||
| sun4v-rtc.h | ||
| xlnx-zynqmp-rtc.h | ||