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

[PATCH for-4.20] public/version: soften wording for deprecated sub-ops


  • To: "xen-devel@xxxxxxxxxxxxxxxxxxxx" <xen-devel@xxxxxxxxxxxxxxxxxxxx>
  • From: Jan Beulich <jbeulich@xxxxxxxx>
  • Date: Mon, 6 Jan 2025 12:04:39 +0100
  • Autocrypt: addr=jbeulich@xxxxxxxx; keydata= xsDiBFk3nEQRBADAEaSw6zC/EJkiwGPXbWtPxl2xCdSoeepS07jW8UgcHNurfHvUzogEq5xk hu507c3BarVjyWCJOylMNR98Yd8VqD9UfmX0Hb8/BrA+Hl6/DB/eqGptrf4BSRwcZQM32aZK 7Pj2XbGWIUrZrd70x1eAP9QE3P79Y2oLrsCgbZJfEwCgvz9JjGmQqQkRiTVzlZVCJYcyGGsD /0tbFCzD2h20ahe8rC1gbb3K3qk+LpBtvjBu1RY9drYk0NymiGbJWZgab6t1jM7sk2vuf0Py O9Hf9XBmK0uE9IgMaiCpc32XV9oASz6UJebwkX+zF2jG5I1BfnO9g7KlotcA/v5ClMjgo6Gl MDY4HxoSRu3i1cqqSDtVlt+AOVBJBACrZcnHAUSuCXBPy0jOlBhxPqRWv6ND4c9PH1xjQ3NP nxJuMBS8rnNg22uyfAgmBKNLpLgAGVRMZGaGoJObGf72s6TeIqKJo/LtggAS9qAUiuKVnygo 3wjfkS9A3DRO+SpU7JqWdsveeIQyeyEJ/8PTowmSQLakF+3fote9ybzd880fSmFuIEJldWxp Y2ggPGpiZXVsaWNoQHN1c2UuY29tPsJgBBMRAgAgBQJZN5xEAhsDBgsJCAcDAgQVAggDBBYC AwECHgECF4AACgkQoDSui/t3IH4J+wCfQ5jHdEjCRHj23O/5ttg9r9OIruwAn3103WUITZee e7Sbg12UgcQ5lv7SzsFNBFk3nEQQCACCuTjCjFOUdi5Nm244F+78kLghRcin/awv+IrTcIWF hUpSs1Y91iQQ7KItirz5uwCPlwejSJDQJLIS+QtJHaXDXeV6NI0Uef1hP20+y8qydDiVkv6l IreXjTb7DvksRgJNvCkWtYnlS3mYvQ9NzS9PhyALWbXnH6sIJd2O9lKS1Mrfq+y0IXCP10eS FFGg+Av3IQeFatkJAyju0PPthyTqxSI4lZYuJVPknzgaeuJv/2NccrPvmeDg6Coe7ZIeQ8Yj t0ARxu2xytAkkLCel1Lz1WLmwLstV30g80nkgZf/wr+/BXJW/oIvRlonUkxv+IbBM3dX2OV8 AmRv1ySWPTP7AAMFB/9PQK/VtlNUJvg8GXj9ootzrteGfVZVVT4XBJkfwBcpC/XcPzldjv+3 HYudvpdNK3lLujXeA5fLOH+Z/G9WBc5pFVSMocI71I8bT8lIAzreg0WvkWg5V2WZsUMlnDL9 mpwIGFhlbM3gfDMs7MPMu8YQRFVdUvtSpaAs8OFfGQ0ia3LGZcjA6Ik2+xcqscEJzNH+qh8V m5jjp28yZgaqTaRbg3M/+MTbMpicpZuqF4rnB0AQD12/3BNWDR6bmh+EkYSMcEIpQmBM51qM EKYTQGybRCjpnKHGOxG0rfFY1085mBDZCH5Kx0cl0HVJuQKC+dV2ZY5AqjcKwAxpE75MLFkr wkkEGBECAAkFAlk3nEQCGwwACgkQoDSui/t3IH7nnwCfcJWUDUFKdCsBH/E5d+0ZnMQi+G0A nAuWpQkjM1ASeQwSHEeAWPgskBQL
  • Cc: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>, Julien Grall <julien@xxxxxxx>, Stefano Stabellini <sstabellini@xxxxxxxxxx>, Anthony PERARD <anthony.perard@xxxxxxxxxx>, Michal Orzel <michal.orzel@xxxxxxx>, Roger Pau Monné <roger.pau@xxxxxxxxxx>, Oleksii Kurochko <oleksii.kurochko@xxxxxxxxx>
  • Delivery-date: Mon, 06 Jan 2025 11:04:43 +0000
  • List-id: Xen developer discussion <xen-devel.lists.xenproject.org>

These interfaces were - afaict - originally introduced this way on the
firm assumption that the used array sizes would be good virtually
forever.  While this assumption turned out to not be true for at least
some of them, this still doesn't really render them "broken": They still
fit their original purpose, and they are still usable for a fair subset
of environments.  Re-word the comments accordingly.

Signed-off-by: Jan Beulich <jbeulich@xxxxxxxx>
---
Despite having looked at the series back when it was posted / discussed,
I'm (now) somewhat puzzled that XENVER_compile_info didn't gain a non-
truncating replacement sub-op. The commit's description doesn't say
anything in this regard; it rather gives the impression that all sub-ops
with limitations would gain unrestricted counterparts.

--- a/xen/include/public/version.h
+++ b/xen/include/public/version.h
@@ -22,7 +22,8 @@
 /*
  * arg == xen_extraversion_t.
  *
- * This API/ABI is broken.  Use XENVER_extraversion2 where possible.
+ * This API/ABI is deprecated, for its size limitation.  Use
+ * XENVER_extraversion2 where possible.
  */
 #define XENVER_extraversion 1
 typedef char xen_extraversion_t[16];
@@ -31,7 +32,8 @@ typedef char xen_extraversion_t[16];
 /*
  * arg == xen_compile_info_t.
  *
- * This API/ABI is broken and truncates data.
+ * This API/ABI is deprecated, for its size limitations.  It may in particular
+ * silently truncate data.
  */
 #define XENVER_compile_info 2
 struct xen_compile_info {
@@ -45,7 +47,8 @@ typedef struct xen_compile_info xen_comp
 /*
  * arg == xen_capabilities_info_t.
  *
- * This API/ABI is broken.  Use XENVER_capabilities2 where possible.
+ * This API/ABI is deprecated, for its size limitation.  Use
+ * XENVER_capabilities2 where possible.
  */
 #define XENVER_capabilities 3
 typedef char xen_capabilities_info_t[1024];
@@ -54,7 +57,8 @@ typedef char xen_capabilities_info_t[102
 /*
  * arg == xen_changeset_info_t.
  *
- * This API/ABI is broken.  Use XENVER_changeset2 where possible.
+ * This API/ABI is deprecated, for its size limitation.  Use
+ * XENVER_changeset2 where possible.
  */
 #define XENVER_changeset 4
 typedef char xen_changeset_info_t[64];
@@ -116,7 +120,8 @@ typedef struct xen_feature_info xen_feat
 /*
  * arg == xen_commandline_t.
  *
- * This API/ABI is broken.  Use XENVER_commandline2 where possible.
+ * This API/ABI is deprecated, for its size limitation.  Use
+ * XENVER_commandline2 where possible.
  */
 #define XENVER_commandline 9
 typedef char xen_commandline_t[1024];



 


Rackspace

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