From a3674c0e1890a892249c76e147ced8f7d1e98df9 Mon Sep 17 00:00:00 2001 From: Onong Tayeng Date: Wed, 13 May 2020 21:25:57 +0530 Subject: lisp: API doc/comments cleanup Removing the comments around eid_type which seem to have been overlooked by the original patch https://gerrit.fd.io/r/c/vpp/+/24663. NOTE: This patch is a doc-only change. It does two things: 1. Remove comments around obsolete eid_type type 2. Update the comments to reflect the new vl_api_eid_t type This is to ensure correct documentation is displayed to user/reader of VPP docs in 20.05. Type: fix Signed-off-by: Onong Tayeng Change-Id: I48e1993cf8869cb32e159d1956f3ec1e5943e33f (cherry picked from commit 4ab5190eb4167ac4c06cd649ec8a860784ab1d41) --- src/vnet/lisp-cp/lisp.api | 23 +++-------------------- src/vnet/lisp-cp/one.api | 18 +++--------------- src/vnet/lisp-gpe/lisp_gpe.api | 6 ------ 3 files changed, 6 insertions(+), 41 deletions(-) (limited to 'src') diff --git a/src/vnet/lisp-cp/lisp.api b/src/vnet/lisp-cp/lisp.api index de4fd515c1a..50d72527193 100644 --- a/src/vnet/lisp-cp/lisp.api +++ b/src/vnet/lisp-cp/lisp.api @@ -72,7 +72,7 @@ autoreply define lisp_add_del_locator @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete - @param eid - EID can be ip4, ip6 or mac + @param eid - endpoint identifier @param locator_set_name - name of locator_set to add/del eid-table @param vni - virtual network instance @param key - secret key @@ -434,15 +434,9 @@ define lisp_locator_set_dump is negative @param action - negative map request action @param is_local - local if non-zero, else remote - @param eid_type: - 0 : ipv4 - 1 : ipv6 - 2 : mac @param is_src_dst - EID is type of source/destination - @param eid - EID can be ip4, ip6 or mac - @param eid_prefix_len - prefix length - @param seid - source EID can be ip4, ip6 or mac - @param seid_prefix_len - source prefix length + @param deid - dst EID + @param seid - src EID @param vni - virtual network instance @param ttl - time to live @param authoritative - authoritative @@ -475,11 +469,6 @@ define lisp_eid_table_details @param vni - virtual network instance; valid only if eid_set != 0 @param prefix_length - prefix length if EID is IP address; valid only if eid_set != 0 - @param eid_type - EID type; valid only if eid_set != 0 - Supported values: - 0: EID is IPv4 - 1: EID is IPv6 - 2: EID is ethernet address @param eid - endpoint identifier @param filter - filter type; Support values: @@ -499,14 +488,8 @@ define lisp_eid_table_dump }; /** \brief LISP adjacency - @param eid_type - - 0 : ipv4 - 1 : ipv6 - 2 : mac @param reid - remote EID @param leid - local EID - @param reid_prefix_len - remote EID IP prefix length - @param leid_prefix_len - local EID IP prefix length */ typedef lisp_adjacency { diff --git a/src/vnet/lisp-cp/one.api b/src/vnet/lisp-cp/one.api index 7318ba4f866..be3a444e263 100644 --- a/src/vnet/lisp-cp/one.api +++ b/src/vnet/lisp-cp/one.api @@ -73,12 +73,7 @@ autoreply define one_add_del_locator @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete - @param eid_type: - 0 : ipv4 - 1 : ipv6 - 2 : mac - @param eid - EID can be ip4, ip6 or mac - @param prefix_len - prefix len + @param eid - endpoint identifier @param locator_set_name - name of locator_set to add/del eid-table @param vni - virtual network instance @param key - secret key @@ -646,15 +641,14 @@ define one_locator_set_dump }; /** \brief Dump ONE eid-table - @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param locator_set_index - index of locator_set, if ~0 then the mapping is negative @param action - negative map request action @param is_local - local if non-zero, else remote @param is_src_dst - EID is type of source/destination - @param deid - EID can be ip4, ip6 or mac - @param seid - source EID can be ip4, ip6 or mac + @param deid - dst EID + @param seid - src EID @param vni - virtual network instance @param ttl - time to live @param authoritative - authoritative @@ -701,14 +695,8 @@ define one_eid_table_dump }; /** \brief ONE adjacency - @param eid_type - - 0 : ipv4 - 1 : ipv6 - 2 : mac @param reid - remote EID @param leid - local EID - @param reid_prefix_len - remote EID IP prefix length - @param leid_prefix_len - local EID IP prefix length */ typedef one_adjacency { diff --git a/src/vnet/lisp-gpe/lisp_gpe.api b/src/vnet/lisp-gpe/lisp_gpe.api index 9fbd795a071..6c751eabffb 100644 --- a/src/vnet/lisp-gpe/lisp_gpe.api +++ b/src/vnet/lisp-gpe/lisp_gpe.api @@ -33,14 +33,8 @@ typedef gpe_locator @param client_index - opaque cookie to identify the sender @param context - sender context, to match reply w/ request @param is_add - add address if non-zero, else delete - @param eid_type - - 0 : ipv4 - 1 : ipv6 - 2 : mac @param rmt_eid - remote eid @param lcl_eid - local eid - @param rmt_len - remote prefix len - @param lcl_len - local prefix len @param vni - virtual network identifier @param dp_table - vrf/bridge domain id @param action - negative action when 0 locators configured -- cgit 1.2.3-korg