From da33105973e5f98d9c0daf8e107299d6a278d146 Mon Sep 17 00:00:00 2001 From: Nathan Skrzypczak Date: Wed, 29 Sep 2021 15:28:26 +0200 Subject: [PATCH] fib: doc nitfixes Type: improvement Change-Id: I29346c849a5e1ff3c2ea399671f9f50d075e9f18 Signed-off-by: Nathan Skrzypczak --- src/vnet/fib/fib_path_list.c | 2 +- src/vnet/fib/fib_types.api | 2 +- src/vnet/fib/ip4_fib.c | 2 +- src/vnet/fib/ip6_fib.c | 2 +- src/vnet/fib/mpls_fib.c | 4 ++-- src/vnet/fib/mpls_fib.h | 2 +- src/vnet/mfib/ip4_mfib.c | 6 +++--- src/vnet/mfib/ip6_mfib.c | 10 +++++----- src/vnet/mfib/mfib_entry.c | 4 ++-- src/vnet/mfib/mfib_itf.c | 4 ++-- 10 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/vnet/fib/fib_path_list.c b/src/vnet/fib/fib_path_list.c index 15d480cb43d..df08bb2b0d0 100644 --- a/src/vnet/fib/fib_path_list.c +++ b/src/vnet/fib/fib_path_list.c @@ -1312,7 +1312,7 @@ fib_path_list_child_add (fib_node_index_t path_list_index, * threshold. then walk children to update. * We don't undo this action. The rational being that the number * of entries using this prefix is large enough such that it is a - * non-trival amount of effort to converge them. If we get into the + * non-trivial amount of effort to converge them. If we get into the * situation where we are adding and removing entries such that we * flip-flop over the threshold, then this non-trivial work is added * to each of those routes adds/deletes - not a situation we want. diff --git a/src/vnet/fib/fib_types.api b/src/vnet/fib/fib_types.api index c5fbcf8fc29..c0e467f6fd6 100644 --- a/src/vnet/fib/fib_types.api +++ b/src/vnet/fib/fib_types.api @@ -102,7 +102,7 @@ enum fib_path_type not given) @param weight - The weight, for UCMP @param preference - The preference of the path. lowest preference - is prefered + is preferred @param rpf-id - For paths that pop to multicast, this the the RPF ID the packet will be given (0 and ~0 => unset) @param type - the path type diff --git a/src/vnet/fib/ip4_fib.c b/src/vnet/fib/ip4_fib.c index a343c2b5f37..2fa5d7e00ca 100644 --- a/src/vnet/fib/ip4_fib.c +++ b/src/vnet/fib/ip4_fib.c @@ -481,7 +481,7 @@ ip4_show_fib (vlib_main_t * vm, * entries for each table. * * @note This command will run for a long time when the FIB tables are - * comprised of millions of entries. For those senarios, consider displaying + * comprised of millions of entries. For those scenarios, consider displaying * a single table or summary mode. * * @cliexpar diff --git a/src/vnet/fib/ip6_fib.c b/src/vnet/fib/ip6_fib.c index 62bf16f0efc..708fddce66a 100644 --- a/src/vnet/fib/ip6_fib.c +++ b/src/vnet/fib/ip6_fib.c @@ -772,7 +772,7 @@ ip6_show_fib (vlib_main_t * vm, * entries for each table. * * @note This command will run for a long time when the FIB tables are - * comprised of millions of entries. For those senarios, consider displaying + * comprised of millions of entries. For those scenarios, consider displaying * in summary mode. * * @cliexpar diff --git a/src/vnet/fib/mpls_fib.c b/src/vnet/fib/mpls_fib.c index 494d0106bae..0ed2413242f 100644 --- a/src/vnet/fib/mpls_fib.c +++ b/src/vnet/fib/mpls_fib.c @@ -22,7 +22,7 @@ * packets. Whether the two actions are the same more often than they are * different, or vice versa, is a function of the deployment in which the router * is used and thus not predictable. - * The desgin choice to make with an MPLS_FIB table is: + * The design choice to make with an MPLS_FIB table is: * 1 - 20 bit key: label only. * When the EOS and non-EOS actions differ the result is a 'EOS-choice' object. * 2 - 21 bit key: label and EOS-bit. @@ -33,7 +33,7 @@ * - lower memory overhead, since there are few DB entries. * Disadvantages: * - slower DP performance in the case the chains differ, as more objects are - * encounterd in the switch path + * encountered in the switch path * * 21 bit key: * Advantages: diff --git a/src/vnet/fib/mpls_fib.h b/src/vnet/fib/mpls_fib.h index 33eaa88ca9d..e7ea5d583d1 100644 --- a/src/vnet/fib/mpls_fib.h +++ b/src/vnet/fib/mpls_fib.h @@ -54,7 +54,7 @@ typedef struct mpls_fib_t_ /** * The load-balance indices keyed by 21 bit label+eos bit. - * A flat array for maximum lookup performace. + * A flat array for maximum lookup performance. */ index_t mf_lbs[MPLS_FIB_DB_SIZE]; } mpls_fib_t; diff --git a/src/vnet/mfib/ip4_mfib.c b/src/vnet/mfib/ip4_mfib.c index c1a9740b3bb..206e451e95c 100644 --- a/src/vnet/mfib/ip4_mfib.c +++ b/src/vnet/mfib/ip4_mfib.c @@ -590,12 +590,13 @@ ip4_show_mfib (vlib_main_t * vm, return 0; } +/* clang-format off */ /*? * This command displays the IPv4 MulticasrFIB Tables (VRF Tables) and * the route entries for each table. * * @note This command will run for a long time when the FIB tables are - * comprised of millions of entries. For those senarios, consider displaying + * comprised of millions of entries. For those scenarios, consider displaying * a single table or summary mode. * * @cliexpar @@ -632,10 +633,9 @@ ip4_show_mfib (vlib_main_t * vm, * 32 4 * @cliexend ?*/ -/* *INDENT-OFF* */ +/* clang-format on */ VLIB_CLI_COMMAND (ip4_show_mfib_command, static) = { .path = "show ip mfib", .short_help = "show ip mfib [summary] [table ] [index ] [[/]] [] [ ]", .function = ip4_show_mfib, }; -/* *INDENT-ON* */ diff --git a/src/vnet/mfib/ip6_mfib.c b/src/vnet/mfib/ip6_mfib.c index 37ae3776d89..de6cbf3d37c 100644 --- a/src/vnet/mfib/ip6_mfib.c +++ b/src/vnet/mfib/ip6_mfib.c @@ -730,12 +730,13 @@ ip6_show_mfib (vlib_main_t * vm, return 0; } -/* +/* clang-format off */ +/*? * This command displays the IPv6 MulticasrFIB Tables (VRF Tables) and * the route entries for each table. * * @note This command will run for a long time when the FIB tables are - * comprised of millions of entries. For those senarios, consider displaying + * comprised of millions of entries. For those scenarios, consider displaying * a single table or summary mode. * * @cliexpar @@ -771,14 +772,13 @@ ip6_show_mfib (vlib_main_t * vm, * 24 2 * 32 4 * @cliexend - */ -/* *INDENT-OFF* */ + ?*/ +/* clang-format on */ VLIB_CLI_COMMAND (ip6_show_fib_command, static) = { .path = "show ip6 mfib", .short_help = "show ip mfib [summary] [table ] [index ] [[/]] [] [ ]", .function = ip6_show_mfib, }; -/* *INDENT-ON* */ static clib_error_t * ip6_mfib_init (vlib_main_t * vm) diff --git a/src/vnet/mfib/mfib_entry.c b/src/vnet/mfib/mfib_entry.c index 2d47c3cdd31..1b685d68482 100644 --- a/src/vnet/mfib/mfib_entry.c +++ b/src/vnet/mfib/mfib_entry.c @@ -1659,8 +1659,8 @@ show_mfib_entry_command (vlib_main_t * vm, } /*? - * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique - * numerical indentifier. + * This command displays an entry, or all entries, in the mfib tables indexed + * by their unique numerical identifier. ?*/ VLIB_CLI_COMMAND (show_mfib_entry, static) = { .path = "show mfib entry", diff --git a/src/vnet/mfib/mfib_itf.c b/src/vnet/mfib/mfib_itf.c index 99408f79f89..b323d3e4a96 100644 --- a/src/vnet/mfib/mfib_itf.c +++ b/src/vnet/mfib/mfib_itf.c @@ -261,8 +261,8 @@ show_mfib_itf_command (vlib_main_t * vm, } /*? - * This commnad displays an MFIB interface, or all interfaces, indexed by their unique - * numerical indentifier. + * This command displays an MFIB interface, or all interfaces, indexed by their + * unique numerical identifier. ?*/ VLIB_CLI_COMMAND (show_mfib_itf, static) = { .path = "show mfib interface", -- 2.16.6