Skip to content

Commit

Permalink
pvcalls: Clearly spell out that the header is just a reference
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Julien Grall authored and sstabellini committed Jul 10, 2020
1 parent 3fdc211 commit 8655fb5
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions xen/include/public/io/pvcalls.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
*
* Refer to docs/misc/pvcalls.markdown for the specification
*
* The header is provided as a C reference for the specification. In
* case of conflict, the specification is authoritative.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
* deal in the Software without restriction, including without limitation the
Expand Down

0 comments on commit 8655fb5

Please sign in to comment.