[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[xen staging] pvcalls: Clearly spell out that the header is just a reference

commit 8655fb5f468e85536d4647c9fdd5140005d56d83
Author:     Julien Grall <jgrall@xxxxxxxxxx>
AuthorDate: Sat Jun 27 10:55:32 2020 +0100
Commit:     Stefano Stabellini <sstabellini@xxxxxxxxxx>
CommitDate: Fri Jul 10 09:49:24 2020 -0700

    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.
    Signed-off-by: Julien Grall <jgrall@xxxxxxxxxx>
    Reviewed-by: Juergen Gross <jgross@xxxxxxxx>
    Acked-by: Stefano Stabellini <sstabellini@xxxxxxxxxx>
    Release-acked-by: Paul Durrant <paul@xxxxxxx>
    Signed-off-by: Stefano Stabellini <stefano.stabellini@xxxxxxxxxx>
 xen/include/public/io/pvcalls.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/xen/include/public/io/pvcalls.h b/xen/include/public/io/pvcalls.h
index cb8171275c..905880735d 100644
--- a/xen/include/public/io/pvcalls.h
+++ b/xen/include/public/io/pvcalls.h
@@ -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
generated by git-patchbot for /home/xen/git/xen.git#staging



Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.