diff mbox series

[2/2] doc: add PMD power management to doxygen API index

Message ID a3ff8306eefe69c6be95369c89cb3dbd245a69e5.1614774908.git.anatoly.burakov@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] doc: add power intrinsics to doxygen API index |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/travis-robot success travis build: passed
ci/github-robot success github build: passed

Commit Message

Burakov, Anatoly March 3, 2021, 12:35 p.m. UTC 
  Currently, the PMD power management API header is missing from the API
index generated by doxygen. Add it.

Fixes: 682a645438c5 ("power: add ethdev power management")

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 doc/api/doxy-api-index.md | 1 +
 1 file changed, 1 insertion(+)

Comments

Thomas Monjalon March 17, 2021, 11:12 a.m. UTC | #1 
03/03/2021 13:35, Anatoly Burakov:
> Currently, the PMD power management API header is missing from the API
> index generated by doxygen. Add it.
> 
> Fixes: 682a645438c5 ("power: add ethdev power management")

Cc: stable@dpdk.org

> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
[...]
> --- a/doc/api/doxy-api-index.md
> +++ b/doc/api/doxy-api-index.md
> @@ -96,6 +96,7 @@ The public API headers are grouped by topics:
>    [service cores]      (@ref rte_service.h),
>    [keepalive]          (@ref rte_keepalive.h),
>    [power/freq]         (@ref rte_power.h)
> +  [PMD power]          (@ref rte_power_pmd_mgmt.h)

A comma is missing in previous item.

Fixed, squashed with other patch and applied.

Happy St-Patrick ;)
diff mbox series

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 41eefb7b2d..6886b6f47d 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -96,6 +96,7 @@  The public API headers are grouped by topics:
   [service cores]      (@ref rte_service.h),
   [keepalive]          (@ref rte_keepalive.h),
   [power/freq]         (@ref rte_power.h)
+  [PMD power]          (@ref rte_power_pmd_mgmt.h)
 
 - **layers**:
   [ethernet]           (@ref rte_ether.h),