diff mbox series

[v3,5/6] doc: add dump device private information feature

Message ID 20231125014745.61348-6-lihuisong@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc/features: fix some features and add new features |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

lihuisong (C) Nov. 25, 2023, 1:47 a.m. UTC 
  Add dump device private information feature.

Fixes: edcf22c6d389 ("ethdev: introduce dump API")
Cc: stable@dpdk.org

Signed-off-by: Huisong Li <lihuisong@huawei.com>
Acked-by: Chengwen Feng <fengchengwen@huawei.com>
---
 doc/guides/nics/features.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
diff mbox series

Patch

diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst
index ef061759c7..c5c4dbf745 100644
--- a/doc/guides/nics/features.rst
+++ b/doc/guides/nics/features.rst
@@ -832,6 +832,18 @@  registers and register size).
 * **[related]    API**: ``rte_eth_dev_get_reg_info()``.
 
 
+.. _nic_features_device_private_info_dump:
+
+Device private information dump
+-------------------------------
+
+Supports retrieving device private information to a file. Provided data and
+the order depends on PMD.
+
+* **[implements] eth_dev_ops**: ``eth_dev_priv_dump``.
+* **[related]    API**: ``rte_eth_dev_priv_dump()``.
+
+
 .. _nic_features_led:
 
 LED