From: Julien Grall <julien@xen.org>
To: xen-devel@lists.xenproject.org
Cc: Juergen Gross <jgross@suse.com>, Julien Grall <jgrall@amazon.com>,
paul@xen.org
Subject: [PATCH v4 for-4.14 1/2] pvcalls: Clearly spell out that the header is just a reference
Date: Sat, 27 Jun 2020 10:55:32 +0100 [thread overview]
Message-ID: <20200627095533.14145-2-julien@xen.org> (raw)
In-Reply-To: <20200627095533.14145-1-julien@xen.org>
From: Julien Grall <jgrall@amazon.com>
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
shoudl 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>
---
Changes in v4:
- New patch
---
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 cb8171275c13..905880735dda 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
--
2.17.1
next prev parent reply other threads:[~2020-06-27 9:55 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-27 9:55 [PATCH v4 for-4.14 0/2] pvcalls: Reconciliate the spec and the Julien Grall
2020-06-27 9:55 ` Julien Grall [this message]
2020-06-27 11:55 ` [PATCH v4 for-4.14 1/2] pvcalls: Clearly spell out that the header is just a reference Jürgen Groß
2020-06-29 7:38 ` Paul Durrant
2020-06-27 9:55 ` [PATCH v4 for-4.14 2/2] pvcalls: Document correctly and explicitely the padding for all arches Julien Grall
2020-06-27 11:53 ` Jürgen Groß
2020-06-29 7:37 ` Paul Durrant
2020-06-29 8:28 ` Jan Beulich
2020-06-29 10:03 ` Julien Grall
2020-06-29 11:22 ` Jan Beulich
2020-06-29 11:24 ` Julien Grall
2020-06-29 15:41 ` Stefano Stabellini
2020-07-04 15:29 ` Julien Grall
2020-07-09 12:01 ` Julien Grall
2020-07-09 21:43 ` Stefano Stabellini
2020-07-10 5:44 ` Julien Grall
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200627095533.14145-2-julien@xen.org \
--to=julien@xen.org \
--cc=jgrall@amazon.com \
--cc=jgross@suse.com \
--cc=paul@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).