diff mbox

[dpdk-dev] doc: group classification libraries in doxygen index

Message ID 20171020104756.3297-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Headers

Checks

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

Commit Message

Thomas Monjalon Oct. 20, 2017, 10:47 a.m. UTC 
  The libraries reorder, distributor, EFD, ACL and member seem
to belong to the same category.
The previous categories "layers" and "containers" do not fit well.
It is proposed to group them under "classification" category.

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

Comments

John McNamara Oct. 20, 2017, 4:12 p.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon
> Sent: Friday, October 20, 2017 11:48 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: group classification libraries in doxygen
> index
> 
> The libraries reorder, distributor, EFD, ACL and member seem to belong to
> the same category.
> The previous categories "layers" and "containers" do not fit well.
> It is proposed to group them under "classification" category.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Oct. 23, 2017, 10:33 a.m. UTC | #2 
> > The libraries reorder, distributor, EFD, ACL and member seem to belong to
> > the same category.
> > The previous categories "layers" and "containers" do not fit well.
> > It is proposed to group them under "classification" category.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied
diff mbox

Patch

diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
index 990815f48..402e9c754 100644
--- a/doc/api/doxy-api-index.md
+++ b/doc/api/doxy-api-index.md
@@ -108,9 +108,6 @@  The public API headers are grouped by topics:
   [frag/reass]         (@ref rte_ip_frag.h),
   [LPM IPv4 route]     (@ref rte_lpm.h),
   [LPM IPv6 route]     (@ref rte_lpm6.h),
-  [ACL]                (@ref rte_acl.h),
-  [EFD]                (@ref rte_efd.h),
-  [member]             (@ref rte_member.h)
 
 - **QoS**:
   [metering]           (@ref rte_meter.h),
@@ -122,13 +119,18 @@  The public API headers are grouped by topics:
   [jhash]              (@ref rte_jhash.h),
   [thash]              (@ref rte_thash.h),
   [FBK hash]           (@ref rte_fbk_hash.h),
-  [CRC hash]           (@ref rte_hash_crc.h)
+  [CRC hash]           (@ref rte_hash_crc.h),
+
+- **classification**
+  [reorder]            (@ref rte_reorder.h),
+  [distributor]        (@ref rte_distributor.h),
+  [EFD]                (@ref rte_efd.h),
+  [ACL]                (@ref rte_acl.h),
+  [member]             (@ref rte_member.h)
 
 - **containers**:
   [mbuf]               (@ref rte_mbuf.h),
   [ring]               (@ref rte_ring.h),
-  [distributor]        (@ref rte_distributor.h),
-  [reorder]            (@ref rte_reorder.h),
   [tailq]              (@ref rte_tailq.h),
   [bitmap]             (@ref rte_bitmap.h),