]> rtime.felk.cvut.cz Git - jailhouse.git/commit
Documentation: Improve hypercall subsystem description
authorJan Kiszka <jan.kiszka@siemens.com>
Wed, 29 Jul 2015 06:37:13 +0000 (08:37 +0200)
committerJan Kiszka <jan.kiszka@siemens.com>
Wed, 29 Jul 2015 07:08:42 +0000 (09:08 +0200)
commit78282af0baf3501f9a399c06fadaf6ddc9e86bc3
treec50556b55ef21d95022863da5fe262bb9f44572c
parent2837fee0ade84972d7584cf5ebb18ad1d2d2ea84
Documentation: Improve hypercall subsystem description

Describe so far undocumented functions and also the communication region
structure.

For the latter, we have to expand the generic COMM_REGION_GENERIC_HEADER
macro during a doxygen run. This is achieved by including the generic
header from within the arch-specific one, but only for doxygen
processing. This special treatment is required because doxygen processes
each file directly, even if it should have been processed indirectly
already (here asm/jailhouse_hypercall.h via jailhouse/hypercall.h).

Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
Documentation/Doxyfile
hypervisor/arch/x86/include/asm/jailhouse_hypercall.h
hypervisor/include/jailhouse/hypercall.h