Blame SOURCES/kvm-nbd-Document-timeline-of-various-features.patch

383d26
From 627a30ded957f715a9832e8fe93feb3f03575095 Mon Sep 17 00:00:00 2001
383d26
From: John Snow <jsnow@redhat.com>
383d26
Date: Wed, 27 Mar 2019 17:22:21 +0100
383d26
Subject: [PATCH 082/163] nbd: Document timeline of various features
383d26
383d26
RH-Author: John Snow <jsnow@redhat.com>
383d26
Message-id: <20190327172308.31077-9-jsnow@redhat.com>
383d26
Patchwork-id: 85169
383d26
O-Subject: [RHEL-7.7 qemu-kvm-rhev PATCH 08/55] nbd: Document timeline of various features
383d26
Bugzilla: 1691009
383d26
RH-Acked-by: Stefan Hajnoczi <stefanha@redhat.com>
383d26
RH-Acked-by: Max Reitz <mreitz@redhat.com>
383d26
RH-Acked-by: Miroslav Rezanina <mrezanin@redhat.com>
383d26
383d26
From: Eric Blake <eblake@redhat.com>
383d26
383d26
It can be useful to figure out which NBD protocol features are
383d26
exposed by a server, as well as what features a client will
383d26
take advantage of if available, for a given qemu release.  It's
383d26
not always precise to base features on version numbers (thanks
383d26
to downstream backports), but any documentation is better than
383d26
making users search through git logs themselves.
383d26
383d26
This patch originally stemmed from a request to document that
383d26
pristine 3.0 has a known bug where NBD_OPT_LIST_META_CONTEXT
383d26
with 0 queries forgot to advertise an available
383d26
"qemu:dirty-bitmap" context, but documenting bugs like this (or
383d26
the fact that 3.0 also botched NBD_CMD_CACHE) gets to be too
383d26
much details, especially since buggy releases will be less
383d26
likely connection targets over time.  Instead, I chose to just
383d26
remind users to check stable release branches.
383d26
383d26
Suggested-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
383d26
Signed-off-by: Eric Blake <eblake@redhat.com>
383d26
Message-Id: <20181215135324.152629-3-eblake@redhat.com>
383d26
Reviewed-by: Richard W.M. Jones <rjones@redhat.com>
383d26
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
383d26
(cherry picked from commit ba2d3b3ab217784822e4232f0acd71fc523d571f)
383d26
Signed-off-by: John Snow <jsnow@redhat.com>
383d26
Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>
383d26
---
383d26
 docs/interop/nbd.txt | 19 ++++++++++++++++++-
383d26
 1 file changed, 18 insertions(+), 1 deletion(-)
383d26
383d26
diff --git a/docs/interop/nbd.txt b/docs/interop/nbd.txt
383d26
index 77b5f45..fc64473 100644
383d26
--- a/docs/interop/nbd.txt
383d26
+++ b/docs/interop/nbd.txt
383d26
@@ -15,7 +15,6 @@ Qemu supports the "base:allocation" metadata context as defined in the
383d26
 NBD protocol specification, and also defines an additional metadata
383d26
 namespace "qemu".
383d26
 
383d26
-
383d26
 == "qemu" namespace ==
383d26
 
383d26
 The "qemu" namespace currently contains only one type of context,
383d26
@@ -36,3 +35,21 @@ in addition to "qemu:dirty-bitmap:<dirty-bitmap-export-name>":
383d26
             namespace.
383d26
 * "qemu:dirty-bitmap:" - returns list of all available dirty-bitmap
383d26
                          metadata contexts.
383d26
+
383d26
+= Features by version =
383d26
+
383d26
+The following list documents which qemu version first implemented
383d26
+various features (both as a server exposing the feature, and as a
383d26
+client taking advantage of the feature when present), to make it
383d26
+easier to plan for cross-version interoperability.  Note that in
383d26
+several cases, the initial release containing a feature may require
383d26
+additional patches from the corresponding stable branch to fix bugs in
383d26
+the operation of that feature.
383d26
+
383d26
+* 2.6: NBD_OPT_STARTTLS with TLS X.509 Certificates
383d26
+* 2.8: NBD_CMD_WRITE_ZEROES
383d26
+* 2.10: NBD_OPT_GO, NBD_INFO_BLOCK
383d26
+* 2.11: NBD_OPT_STRUCTURED_REPLY
383d26
+* 2.12: NBD_CMD_BLOCK_STATUS for "base:allocation"
383d26
+* 3.0: NBD_OPT_STARTTLS with TLS Pre-Shared Keys (PSK),
383d26
+NBD_CMD_BLOCK_STATUS for "qemu:dirty-bitmap:", NBD_CMD_CACHE
383d26
-- 
383d26
1.8.3.1
383d26