doc: remove deprecation notice for vhost

Message ID 20211103050026.41516-1-chenbo.xia@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Maxime Coquelin
Headers
Series doc: remove deprecation notice for vhost |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-spell-check-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Chenbo Xia Nov. 3, 2021, 5 a.m. UTC
  Ten vhost APIs were announced to be stable and promoted in below
commit, so remove the related deprecation notice.

Fixes: 945ef8a04098 ("vhost: promote some APIs to stable")

Signed-off-by: Chenbo Xia <chenbo.xia@intel.com>
Reported-by: Maxime Coquelin <maxime.coquelin@redhat.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 --------
 1 file changed, 8 deletions(-)
  

Comments

Chenbo Xia Nov. 3, 2021, 5:25 a.m. UTC | #1
Hi,

I notice that from the start, I should not send the notice.. as the abi policy said:

For removing the experimental tag associated with an API, deprecation notice is not required.

Sorry for the mistake.
/Chenbo

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Chenbo Xia
> Sent: Wednesday, November 3, 2021 1:00 PM
> To: dev@dpdk.org
> Cc: Ray Kinsella <mdr@ashroe.eu>; Kevin Traynor <ktraynor@redhat.com>; Maxime
> Coquelin <maxime.coquelin@redhat.com>
> Subject: [dpdk-dev] [PATCH] doc: remove deprecation notice for vhost
> 
> Ten vhost APIs were announced to be stable and promoted in below
> commit, so remove the related deprecation notice.
> 
> Fixes: 945ef8a04098 ("vhost: promote some APIs to stable")
> 
> Signed-off-by: Chenbo Xia <chenbo.xia@intel.com>
> Reported-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 8 --------
>  1 file changed, 8 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 4366015b01..4f7e95f05f 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -114,14 +114,6 @@ Deprecation Notices
>  * vhost: rename ``struct vhost_device_ops`` to ``struct
> rte_vhost_device_ops``
>    in DPDK v21.11.
> 
> -* vhost: The experimental tags of ``rte_vhost_driver_get_protocol_features``,
> -  ``rte_vhost_driver_get_queue_num``, ``rte_vhost_crypto_create``,
> -  ``rte_vhost_crypto_free``, ``rte_vhost_crypto_fetch_requests``,
> -  ``rte_vhost_crypto_finalize_requests``, ``rte_vhost_crypto_set_zero_copy``,
> -  ``rte_vhost_va_from_guest_pa``, ``rte_vhost_extern_callback_register``,
> -  and ``rte_vhost_driver_set_protocol_features`` functions will be removed
> -  and the API functions will be made stable in DPDK 21.11.
> -
>  * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
>    ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
>    session and the private data of session. An opaque pointer can be exposed
> --
> 2.17.1
  
David Marchand Nov. 3, 2021, 7:03 a.m. UTC | #2
On Wed, Nov 3, 2021 at 6:25 AM Xia, Chenbo <chenbo.xia@intel.com> wrote:
>
> Hi,
>
> I notice that from the start, I should not send the notice.. as the abi policy said:
>
> For removing the experimental tag associated with an API, deprecation notice is not required.
>
> Sorry for the mistake.

It is not required, but announcing does not hurt.
A real issue would be the opposite :-).

Your patch lgtm, thanks Chenbo.
  
Maxime Coquelin Nov. 3, 2021, 8:08 a.m. UTC | #3
On 11/3/21 06:00, Chenbo Xia wrote:
> Ten vhost APIs were announced to be stable and promoted in below
> commit, so remove the related deprecation notice.
> 
> Fixes: 945ef8a04098 ("vhost: promote some APIs to stable")
> 
> Signed-off-by: Chenbo Xia <chenbo.xia@intel.com>
> Reported-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 8 --------
>   1 file changed, 8 deletions(-)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 4366015b01..4f7e95f05f 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -114,14 +114,6 @@ Deprecation Notices
>   * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``
>     in DPDK v21.11.
>   
> -* vhost: The experimental tags of ``rte_vhost_driver_get_protocol_features``,
> -  ``rte_vhost_driver_get_queue_num``, ``rte_vhost_crypto_create``,
> -  ``rte_vhost_crypto_free``, ``rte_vhost_crypto_fetch_requests``,
> -  ``rte_vhost_crypto_finalize_requests``, ``rte_vhost_crypto_set_zero_copy``,
> -  ``rte_vhost_va_from_guest_pa``, ``rte_vhost_extern_callback_register``,
> -  and ``rte_vhost_driver_set_protocol_features`` functions will be removed
> -  and the API functions will be made stable in DPDK 21.11.
> -
>   * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
>     ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
>     session and the private data of session. An opaque pointer can be exposed
> 

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
  
Maxime Coquelin Nov. 3, 2021, 1:47 p.m. UTC | #4
On 11/3/21 06:00, Chenbo Xia wrote:
> Ten vhost APIs were announced to be stable and promoted in below
> commit, so remove the related deprecation notice.
> 
> Fixes: 945ef8a04098 ("vhost: promote some APIs to stable")
> 
> Signed-off-by: Chenbo Xia <chenbo.xia@intel.com>
> Reported-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 8 --------
>   1 file changed, 8 deletions(-)
> 

Applied to dpdk-next-virtio/main.

Thanks,
Maxime
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4366015b01..4f7e95f05f 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -114,14 +114,6 @@  Deprecation Notices
 * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``
   in DPDK v21.11.
 
-* vhost: The experimental tags of ``rte_vhost_driver_get_protocol_features``,
-  ``rte_vhost_driver_get_queue_num``, ``rte_vhost_crypto_create``,
-  ``rte_vhost_crypto_free``, ``rte_vhost_crypto_fetch_requests``,
-  ``rte_vhost_crypto_finalize_requests``, ``rte_vhost_crypto_set_zero_copy``,
-  ``rte_vhost_va_from_guest_pa``, ``rte_vhost_extern_callback_register``,
-  and ``rte_vhost_driver_set_protocol_features`` functions will be removed
-  and the API functions will be made stable in DPDK 21.11.
-
 * cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
   ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
   session and the private data of session. An opaque pointer can be exposed