pvcalls: Clearly spell out that the header is just a reference
authorJulien Grall <jgrall@amazon.com>
Sat, 27 Jun 2020 09:55:32 +0000 (10:55 +0100)
committerStefano Stabellini <sstabellini@kernel.org>
Fri, 10 Jul 2020 16:49:24 +0000 (09:49 -0700)
commit8655fb5f468e85536d4647c9fdd5140005d56d83
treeff0809f4021ed3d2c836cd94b837b3c15e4914c3
parent3fdc211b01b29f252166937238efe02d15cb5780
pvcalls: Clearly spell out that the header is just a reference

A recent thread on xen-devel [1] pointed out that the header was
provided as a reference for the specification.

Unfortunately, this was never written down in xen.git so for an external
user (or a reviewer) it is not clear whether the spec or the header
should be followed when there is a conflict.

To avoid more confusion, a paragraph is added at the top of the header
to clearly spell out it is only provided for reference.

[1] https://lore.kernel.org/xen-devel/alpine.DEB.2.21.2006151343430.9074@sstabellini-ThinkPad-T480s/

Signed-off-by: Julien Grall <jgrall@amazon.com>
Reviewed-by: Juergen Gross <jgross@suse.com>
Acked-by: Stefano Stabellini <sstabellini@kernel.org>
Release-acked-by: Paul Durrant <paul@xen.org>
Signed-off-by: Stefano Stabellini <stefano.stabellini@xilinx.com>
xen/include/public/io/pvcalls.h