[v3] doc: announce bus/vmbus API changes

Message ID 1742242184-19600-1-git-send-email-longli@linuxonhyperv.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] doc: announce bus/vmbus API changes |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed
ci/intel-Functional success Functional PASS

Commit Message

Long Li March 17, 2025, 8:09 p.m. UTC
From: Long Li <longli@microsoft.com>

All vmbus APIs are used internally by DPDK core and net/netvsc PMD.
It's not feasible or practical to use those APIs by the application.
Those APIs will become internal in DPDK 25.11.

Signed-off-by: Long Li <longli@microsoft.com>
---
Change in
v2: add details on what APIs will be changed
v3: remove the reference to version.map

 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Thomas Monjalon March 24, 2025, 6:48 p.m. UTC | #1
17/03/2025 21:09, longli@linuxonhyperv.com:
> From: Long Li <longli@microsoft.com>
> 
> All vmbus APIs are used internally by DPDK core and net/netvsc PMD.
> It's not feasible or practical to use those APIs by the application.
> Those APIs will become internal in DPDK 25.11.
> 
> Signed-off-by: Long Li <longli@microsoft.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 3f5f0e949c..9d3fb318f3 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -138,3 +138,7 @@  Deprecation Notices
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status.
+
+* bus/vmbus: Starting DPDK 25.11, all the vmbus APIs defined in
+  drivers/bus/vmbus/rte_bus_vmbus.h will become internal to DPDK. Those APIs
+  are used internally by DPDK core and net/netvsc PMD.