mirror of
				https://github.com/qemu/qemu.git
				synced 2025-10-31 20:44:16 +00:00 
			
		
		
		
	 ec150c7e09
			
		
	
	
		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>
		
	
			
		
			
				
	
	
		
			26 lines
		
	
	
		
			559 B
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			26 lines
		
	
	
		
			559 B
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * Adjunct Processor (AP) matrix device interfaces
 | |
|  *
 | |
|  * Copyright 2018 IBM Corp.
 | |
|  *
 | |
|  * This work is licensed under the terms of the GNU GPL, version 2 or (at
 | |
|  * your option) any later version. See the COPYING file in the top-level
 | |
|  * directory.
 | |
|  */
 | |
| 
 | |
| #ifndef HW_S390X_AP_DEVICE_H
 | |
| #define HW_S390X_AP_DEVICE_H
 | |
| 
 | |
| #include "hw/qdev-core.h"
 | |
| 
 | |
| #define AP_DEVICE_TYPE       "ap-device"
 | |
| 
 | |
| typedef struct APDevice {
 | |
|     DeviceState parent_obj;
 | |
| } APDevice;
 | |
| 
 | |
| #define AP_DEVICE(obj) \
 | |
|     OBJECT_CHECK(APDevice, (obj), AP_DEVICE_TYPE)
 | |
| 
 | |
| #endif /* HW_S390X_AP_DEVICE_H */
 |