Trivial Typo's in bier comments/docs. 49/19549/2
authorPaul Vinciguerra <pvinci@vinciconsulting.com>
Mon, 13 May 2019 19:56:41 +0000 (15:56 -0400)
committerDave Wallace <dwallacelf@gmail.com>
Mon, 13 May 2019 22:30:28 +0000 (22:30 +0000)
Change-Id: I3b3e868277d5caf6b1341814003a3bc5726c2df9
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
14 files changed:
src/vnet/bier/bier.api
src/vnet/bier/bier_bift_table.c
src/vnet/bier/bier_bift_table.h
src/vnet/bier/bier_bit_string.h
src/vnet/bier/bier_disp_entry.c
src/vnet/bier/bier_disp_entry.h
src/vnet/bier/bier_entry.c
src/vnet/bier/bier_entry.h
src/vnet/bier/bier_fmask.h
src/vnet/bier/bier_hdr_inlines.h
src/vnet/bier/bier_imp.h
src/vnet/bier/bier_imp_node.c
src/vnet/bier/bier_lookup.c
src/vnet/bier/bier_table.h

index da2989b..b5ac8ca 100644 (file)
@@ -21,7 +21,7 @@
 option version = "1.1.0";
 import "vnet/fib/fib_types.api";
 
-/** \brief BIER Table Indentifier
+/** \brief BIER Table Identifier
     @param bt_set - The BIER set
     @param bt_sub_domain - the sud-domain
     @param bt_bit_header_length - the number of bits in the header length
@@ -70,7 +70,7 @@ define bier_table_details
     @param br_bp - The Bit-position value
     @param br_tbl_id - The BIER table-id the route is added in
     @param br_is_add - Is this a route add or delete
-    @param br_is_replace - Are the paths specfied replacing those already
+    @param br_is_replace - Are the paths specified replacing those already
                            present or are they to be combined.
                           is_replace = 1 and n_paths=0 implies delete the
                           route and all paths;
@@ -195,8 +195,8 @@ define bier_disp_table_details
     @param context - sender context, to match reply w/ request
     @param bde_bp - The Bit-position value for the entry, i.e. the sender's
                     Use 0 for the default (match any source) entry.
-    @param bde_tbl_id - The BIER dispositiontable-id the route is added in
-    @param bde_next_hop_sw_if_index - the nextop interface
+    @param bde_tbl_id - The BIER disposition table-id the route is added in
+    @param bde_next_hop_sw_if_index - the next hop interface
     @param bde_is_add - Is this a route add or delete
     @param bde_payload_proto - The payload protocol for which the next-hop
                               is added
index 76e29dc..f226779 100644 (file)
@@ -286,6 +286,6 @@ done:
 
 VLIB_CLI_COMMAND (show_bier_bift_command, static) = {
     .path = "show bier bift",
-    .short_help = "show bier bift [set <value> sd <value> bsl <value>]",
+    .short_help = "show bier bift [set <value>] [sd <value>] [bsl <value>]",
     .function = show_bier_bift_cmd,
 };
index bc77c37..9d18877 100644 (file)
@@ -21,8 +21,8 @@
 #include <vnet/mpls/packet.h>
 
 /*
- * the lookup table used to get from a BFIT_ID to a load-balance.
- * As per-draft draft-ietf-bier-mpls-encapsulation-10 this isthe
+ * the lookup table used to get from a BIFT_ID to a load-balance.
+ * As per-draft draft-ietf-bier-mpls-encapsulation-10 this is the
  * use case for non-MPLS networks
  */
 #define BIER_BIFT_N_ENTRIES (1 << 20)
index fa42e6a..570b92d 100644 (file)
@@ -47,7 +47,7 @@ extern void bier_bit_string_clear_bit(bier_bit_string_t *mask,
 
 extern u8 *format_bier_bit_string(u8 * s, va_list * args);
 
-#define BIER_BBS_NUM_INT_BUKCETS(_bbs) \
+#define BIER_BBS_NUM_INT_BUCKETS(_bbs) \
     (BIER_BBS_LEN_TO_BUCKETS(_bbs->bbs_len) / sizeof(int))
 
 always_inline int
@@ -56,7 +56,7 @@ bier_bit_string_is_zero (const bier_bit_string_t *src)
     u16 index;
 
     for (index = 0;
-         index < BIER_BBS_NUM_INT_BUKCETS(src);
+         index < BIER_BBS_NUM_INT_BUCKETS(src);
          index++) {
         if (((int*)src->bbs_buckets)[index] != 0) {
             return (0);
@@ -74,7 +74,7 @@ bier_bit_string_clear_string (const bier_bit_string_t *src,
     ASSERT(src->bbs_len == dest->bbs_len);
 
     for (index = 0;
-         index < BIER_BBS_NUM_INT_BUKCETS(src);
+         index < BIER_BBS_NUM_INT_BUCKETS(src);
          index++) {
         ((int*)dest->bbs_buckets)[index] &= ~(((int*)src->bbs_buckets)[index]);
     }
@@ -89,7 +89,7 @@ bier_bit_string_logical_and_string (const bier_bit_string_t *src,
     ASSERT(src->bbs_len == dest->bbs_len);
 
     for (index = 0;
-         index < BIER_BBS_NUM_INT_BUKCETS(src);
+         index < BIER_BBS_NUM_INT_BUCKETS(src);
          index++) {
         ((int*)dest->bbs_buckets)[index] &= ((int*)src->bbs_buckets)[index];
     }
index c143776..ae1256e 100644 (file)
@@ -175,7 +175,7 @@ bier_disp_entry_path_add (index_t bdei,
     old_pli = *pli;
 
     /*
-     * create a new or update the exisitng path-list for this
+     * create a new or update the existing path-list for this
      * payload protocol
      */
     if (FIB_NODE_INDEX_INVALID == *pli)
@@ -211,7 +211,7 @@ bier_disp_entry_path_remove (index_t bdei,
     old_pli = *pli;
 
     /*
-     * update the exisitng path-list for this payload protocol
+     * update the existing path-list for this payload protocol
      */
     if (FIB_NODE_INDEX_INVALID != *pli)
     {
index db381a8..59481f6 100644 (file)
@@ -36,8 +36,8 @@ typedef struct bier_disp_entry_t_ {
     CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 
     /**
-     * The DPO contirubted from the per-payload protocol parents
-     * on cachline 1.
+     * The DPO contributed from the per-payload protocol parents
+     * on cacheline 1.
      */
     struct
     {
index 80f7cfd..77d96b8 100644 (file)
@@ -224,7 +224,7 @@ bier_entry_path_add (index_t bei,
     }
 
     /*
-     * update the ECNP tables with the new choice
+     * update the ECMP tables with the new choice
      */
     bier_table_ecmp_walk(be->be_bti,
                          bier_entry_table_ecmp_walk_add_fmask,
@@ -280,7 +280,7 @@ bier_entry_path_update (index_t bei,
     }
 
     /*
-     * update the ECNP tables with the new choice
+     * update the ECMP tables with the new choice
      */
     bier_table_ecmp_walk(be->be_bti,
                          bier_entry_table_ecmp_walk_add_fmask,
@@ -342,7 +342,7 @@ bier_entry_path_remove (index_t bei,
     fib_path_list_unlock(old_pl_index);
 
     /*
-     * update the ECNP tables with the new choice
+     * update the ECMP tables with the new choice
      */
     bier_table_ecmp_walk(be->be_bti,
                          bier_entry_table_ecmp_walk_add_fmask,
index 629e47a..afa90ab 100644 (file)
@@ -16,7 +16,7 @@
  * bier_entry : The BIER entry
  *
  * The interface to the BIER entry is through a bier_entry_t* rather
- * than an index. This is becuase the BIER table allocates the entries
+ * than an index. This is because the BIER table allocates the entries
  * in a contiguous array once and only once when the table is created.
  * this is done for forwarding performance. The entry is thus not subject
  * to realloc, and does not need to be malloc'd when a route to that
index 2317a50..e522b03 100644 (file)
  * egress towards the next-hop. As such the fmask is part of the rewrite
  * (adj) for that next-hop. It it thus an extension of the next-hop and in
  * no way associated with the bit-position(s) that are reachable through it.
- * Fmasks are thus shared by bit-positions that egress throught the same
+ * Fmasks are thus shared by bit-positions that egress through the same
  * nh (BFR-NBR).
- * Deag fmasks are also shread in the event that a router has local
- * bit-positions. This is necessary to prevent the router recieving two copies
+ * Deag fmasks are also shared in the event that a router has local
+ * bit-positions. This is necessary to prevent the router receiving two copies
  * of each packet. Consequently it also means that they share the same
  * disposition data for the global data.
  */
index 81e196d..e824997 100644 (file)
@@ -48,7 +48,7 @@
 #define BIER_HDR_1ST_NIBBLE_VALUE 0x5
 
 /**
- * Mask and shift values for fields in the headers trainling word
+ * Mask and shift values for fields in the headers training word
  */
 #define BIER_HDR_PROTO_FIELD_MASK   0x003f
 #define BIER_HDR_OAM_FIELD_MASK     0xc000
index f458772..7480ebc 100644 (file)
@@ -38,7 +38,7 @@ typedef struct bier_imp_t_ {
     CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 
     /**
-     * The DPO contirubted from the resolving BIER table.
+     * The DPO contributed from the resolving BIER table.
      * One per-IP protocol. This allows us to share a BIER imposition
      * object for a IPv4 and IPv6 mfib path.
      */
index 727e92e..8b20325 100644 (file)
@@ -143,7 +143,7 @@ bier_imp_dpo_inline (vlib_main_t * vm,
                                          BIER_HDR_ENTROPY_FIELD_SHIFT);
 
                 /*
-                 * use TTL 64 for the post enacp MPLS label/BIFT-ID
+                 * use TTL 64 for the post encap MPLS label/BIFT-ID
                  * this we be decremented in bier_output node.
                  */
                 vnet_buffer(b0)->mpls.ttl = 65;
index 402bcbc..ec75efb 100644 (file)
@@ -44,7 +44,7 @@ static char * bier_lookup_error_strings[] = {
 };
 
 /*
- * Keep these values sematically the same as BIER lookup
+ * Keep these values semantically the same as BIER lookup
  */
 #define foreach_bier_lookup_next                \
     _(DROP, "bier-drop")                        \
index 5264e4c..2fd3ea3 100644 (file)
@@ -33,7 +33,7 @@ struct bier_route_update_t_;
  * Each entry (bit-position) represents one destination, and its reachability
  *
  * The number of entries in a table is thus the maximum supported
- * bit-position. Since this is smal <4096, the table is a flat arry
+ * bit-position. Since this is small <4096, the table is a flat array
  */
 typedef struct bier_table_t_ {
     /**