diff mbox

[dpdk-dev] doc: remove driver interface header from API index

Message ID 20170714144525.29824-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon July 14, 2017, 2:45 p.m. UTC 
  The file rte_flow_driver.h is a driver interface,
thus it should not be listed in the API index.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/api/doxy-api-index.md | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Thomas Monjalon July 21, 2017, 4:31 p.m. UTC | #1 
14/07/2017 17:45, Thomas Monjalon:
> The file rte_flow_driver.h is a driver interface,
> thus it should not be listed in the API index.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Applied
diff mbox

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 172f35611..b8d9d49be 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -33,14 +33,13 @@  API {#index}
   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 -->
 
-There are many libraries, so their headers may be grouped by topics:
+The public API headers are grouped by topics:
 
 - **device**:
   [dev]                (@ref rte_dev.h),
   [ethdev]             (@ref rte_ethdev.h),
   [ethctrl]            (@ref rte_eth_ctrl.h),
   [rte_flow]           (@ref rte_flow.h),
-  [rte_flow_driver]    (@ref rte_flow_driver.h),
   [rte_tm]             (@ref rte_tm.h),
   [cryptodev]          (@ref rte_cryptodev.h),
   [eventdev]           (@ref rte_eventdev.h),