[5/5] doc/features: add dump device private information feature
Checks
Commit Message
Add dump device private information feature.
Fixes: edcf22c6d389 ("ethdev: introduce dump API")
Cc: stable@dpdk.org
Signed-off-by: Huisong Li <lihuisong@huawei.com>
---
doc/guides/nics/features.rst | 12 ++++++++++++
1 file changed, 12 insertions(+)
Comments
23/11/2023 14:59, Huisong Li:
> +.. _nic_features_device_private_info_dump:
> +
> +Device private information dump
> +--------------
Why underlining is too short?
> +
> +Supports retrieving device private information to a file. Provided data and
> +the order depends on PMD.
> +
> +* **[mplements] eth_dev_ops**: ``eth_dev_priv_dump``.
looks like a typo here
> +* **[related] API**: ``rte_eth_dev_priv_dump()``.
在 2023/11/23 22:18, Thomas Monjalon 写道:
> 23/11/2023 14:59, Huisong Li:
>> +.. _nic_features_device_private_info_dump:
>> +
>> +Device private information dump
>> +--------------
> Why underlining is too short?
You are right.
Then I got this warning email which is the same as you said.😁
will fix it in v2.
>
>> +
>> +Supports retrieving device private information to a file. Provided data and
>> +the order depends on PMD.
>> +
>> +* **[mplements] eth_dev_ops**: ``eth_dev_priv_dump``.
> looks like a typo here
Ack.
>
>> +* **[related] API**: ``rte_eth_dev_priv_dump()``.
>
>
> .
@@ -820,6 +820,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.
+
+* **[mplements] eth_dev_ops**: ``eth_dev_priv_dump``.
+* **[related] API**: ``rte_eth_dev_priv_dump()``.
+
+
.. _nic_features_led:
LED