Merge pull request #9751 from ewlumpkin/comment_spelling_fixes

lib: fix spelling nits in more lib files' comments

lib/atomlist.c

@@ -121,7 +121,7 @@ static void atomlist_del_core(struct atomlist_head *h,
 					memory_order_consume);
 
 			/* track the beginning of a chain of deleted items
-			 * this is neccessary to make this lock-free; we can
+			 * this is necessary to make this lock-free; we can
 			 * complete deletions started by other threads.
 			 */
 			if (!atomptr_l(prevval)) {

lib/atomlist.h

@@ -100,7 +100,7 @@ static inline bool atomptr_u(atomptr_t val)
 /* single-linked list, unsorted/arbitrary.
  * can be used as queue with add_tail / pop
  *
- * all operations are lock-free, but not neccessarily wait-free.  this means
+ * all operations are lock-free, but not necessarily wait-free.  this means
  * that there is no state where the system as a whole stops making process,
  * but it *is* possible that a *particular* thread is delayed by some time.
  *

lib/bfd.c

@@ -203,7 +203,7 @@ static void bfd_last_update(time_t last_update, char *buf, size_t len)
 	struct tm tm;
 	struct timeval tv;
 
-	/* If no BFD satatus update has ever been received, print `never'. */
+	/* If no BFD status update has ever been received, print `never'. */
 	if (last_update == 0) {
 		snprintf(buf, len, "never");
 		return;

lib/buffer.c

@@ -59,7 +59,7 @@ struct buffer_data {
 /* It should always be true that: 0 <= sp <= cp <= size */
 
 /* Default buffer size (used if none specified).  It is rounded up to the
-   next page boundery. */
+   next page boundary. */
 #define BUFFER_SIZE_DEFAULT		4096
 
 #define BUFFER_DATA_FREE(D) XFREE(MTYPE_BUFFER_DATA, (D))

lib/command.h

@@ -234,7 +234,7 @@ struct cmd_node {
 /* Argc max counts. */
 #define CMD_ARGC_MAX   256
 
-/* Turn off these macros when uisng cpp with extract.pl */
+/* Turn off these macros when using cpp with extract.pl */
 #ifndef VTYSH_EXTRACT_PL
 
 /* helper defines for end-user DEFUN* macros */

lib/command_match.h

@@ -68,7 +68,7 @@ enum match_type {
  * @param[in] vline vectorized input string
  * @param[out] argv pointer to argument list if successful match, NULL
  * otherwise. The elements of this list are pointers to struct cmd_token
- * and represent the sequence of tokens matched by the inpu. The ->arg
+ * and represent the sequence of tokens matched by the input. The ->arg
  * field of each token points to a copy of the input matched on it. These
  * may be safely deleted or modified.
  * @param[out] element pointer to matched cmd_element if successful match,

lib/command_parse.y

@@ -338,7 +338,7 @@ selector: '{' selector_seq_seq '}' varname_token
    * 1) this allows "at least 1 of" semantics, which are otherwise impossible
    * 2) this would add a start->end->start loop in the graph that the current
    *    loop-avoidal fails to handle
-   * just use [{a|b}] if neccessary, that will work perfectly fine, and reason
+   * just use [{a|b}] if necessary, that will work perfectly fine, and reason
    * #1 is good enough to keep it this way. */
 
   loopcheck(ctx, &$$);

lib/db.c

@@ -60,7 +60,7 @@ int db_init(const char *path_fmt, ...)
 			    (SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE), NULL)
 	    != SQLITE_OK) {
 		if (dbp == NULL) {
-			zlog_warn("%s: failed to open dabatase '%s'", __func__,
+			zlog_warn("%s: failed to open database '%s'", __func__,
 				  path);
 			return -1;
 		}

lib/distribute.h

@@ -29,7 +29,7 @@
 extern "C" {
 #endif
 
-/* Disctirubte list types. */
+/* Distribute list types. */
 enum distribute_type {
 	DISTRIBUTE_V4_IN,
 	DISTRIBUTE_V6_IN,

lib/ferr.h

@@ -34,7 +34,7 @@ extern "C" {
 /* return type when this error indication stuff is used.
  *
  * guaranteed to have boolean evaluation to "false" when OK, "true" when error
- * (i.e. can be changed to pointer in the future if neccessary)
+ * (i.e. can be changed to pointer in the future if necessary)
  *
  * For checking, always use "if (value)", nothing else.
  * Do _NOT_ use any integer constant (!= 0), or sign check (< 0).

lib/filter.c

@@ -192,7 +192,7 @@ void access_list_delete(struct access_list *access)
 	access_list_free(access);
 }
 
-/* Insert new access list to list of access_list.  Each acceess_list
+/* Insert new access list to list of access_list.  Each access_list
    is sorted by the name. */
 static struct access_list *access_list_insert(afi_t afi, const char *name)
 {
@@ -387,7 +387,7 @@ void access_list_filter_add(struct access_list *access,
 	struct filter *replace;
 	struct filter *point;
 
-	/* Automatic asignment of seq no. */
+	/* Automatic assignment of seq no. */
 	if (filter->seq == -1)
 		filter->seq = filter_new_seq_get(access);
 

lib/frr_zmq.c

@@ -19,7 +19,7 @@
 
 /*
  * IF YOU MODIFY THIS FILE PLEASE RUN `make check` and ensure that
- * the test_zmq.c unit test is still working.  There are dependancies
+ * the test_zmq.c unit test is still working.  There are dependencies
  * between the two that are extremely fragile.  My understanding
  * is that there is specialized ownership of the cb pointer based
  * upon what is happening.  Those assumptions are supposed to be

lib/frrscript.c

@@ -226,7 +226,7 @@ void *frrscript_get_result(struct frrscript *fs, const char *function_name,
 	p = lua_to(lfs->L, 2);
 
 	/* At the end, the Lua state should be same as it was at the start
-	 * i.e. containing soley the returned table.
+	 * i.e. containing solely the returned table.
 	 */
 	assert(lua_gettop(lfs->L) == 1);
 	assert(lua_istable(lfs->L, -1) == 1);

lib/graph.c

@@ -69,7 +69,7 @@ static void graph_vector_remove(vector v, unsigned int ix)
 	 * and v->active is > ix. */
 	v->active--;
 	/* if ix == v->active--, we set the item to itself, then to NULL...
-	 * still correct, no check neccessary. */
+	 * still correct, no check necessary. */
 	v->index[ix] = v->index[v->active];
 	v->index[v->active] = NULL;
 }

lib/hash.h

@@ -161,7 +161,7 @@ hash_create_size(unsigned int size, unsigned int (*hash_key)(const void *),
  * an element from its key, you must provide the data item itself, with the
  * portions used in the hash function set to the same values as the data item
  * to retrieve. To insert a data element, either provide the key as just
- * described and provide alloc_func as descrbied below to allocate the full
+ * described and provide alloc_func as described below to allocate the full
  * data element, or provide the full data element and pass 'hash_alloc_intern'
  * to alloc_func.
  *

lib/hook.h

@@ -193,7 +193,7 @@ extern void _hook_unregister(struct hook *hook, void *funcptr, void *arg,
  * usage:  DECLARE_HOOK(my_hook, (int arg1, struct foo *arg2), (arg1, arg2));
  * as above, "passlist" must use the same order and same names as "arglist"
  *
- * theoretically passlist is not neccessary, but let's keep things simple and
+ * theoretically passlist is not necessary, but let's keep things simple and
  * use exact same args on DECLARE and DEFINE.
  */
 #define DECLARE_HOOK(hookname, arglist, passlist)                              \

lib/if.c

@@ -341,7 +341,7 @@ static struct interface *if_lookup_by_ifindex(ifindex_t ifindex,
 	return RB_FIND(if_index_head, &vrf->ifaces_by_index, &if_tmp);
 }
 
-/* Interface existance check by index. */
+/* Interface existence check by index. */
 struct interface *if_lookup_by_index(ifindex_t ifindex, vrf_id_t vrf_id)
 {
 	switch (vrf_get_backend()) {
@@ -354,7 +354,7 @@ struct interface *if_lookup_by_index(ifindex_t ifindex, vrf_id_t vrf_id)
 	return NULL;
 }
 
-/* Interface existance check by index. */
+/* Interface existence check by index. */
 struct interface *if_vrf_lookup_by_index_next(ifindex_t ifindex,
 					      vrf_id_t vrf_id)
 {
@@ -406,7 +406,7 @@ ifindex_t ifname2ifindex(const char *name, vrf_id_t vrf_id)
 		       : IFINDEX_INTERNAL;
 }
 
-/* Interface existance check by interface name. */
+/* Interface existence check by interface name. */
 struct interface *if_lookup_by_name(const char *name, vrf_id_t vrf_id)
 {
 	struct vrf *vrf = vrf_lookup_by_id(vrf_id);

lib/if.h

@@ -251,8 +251,8 @@ struct interface {
 	/* Interface MTU. */
 	unsigned int mtu; /* IPv4 MTU */
 	unsigned int
-		mtu6; /* IPv6 MTU - probably, but not neccessarily same as mtu
+		mtu6; /* IPv6 MTU - probably, but not necessarily same as mtu
-			 */
+		       */
 
 	/* Link-layer information and hardware address */
 	enum zebra_link_type ll_type;

lib/lib_errors.c

@@ -41,19 +41,19 @@ static struct log_ref ferr_lib_warn[] = {
 	{
 		.code = EC_LIB_LINUX_NS,
 		.title = "The Linux namespace subsystem has encountered a parsing error",
-		.description = "During system startup an invalid parameter for the namesapce was give to FRR",
+		.description = "During system startup an invalid parameter for the namespace was give to FRR",
 		.suggestion = "Gather log data and open an Issue. restart FRR",
 	},
 	{
 		.code = EC_LIB_SLOW_THREAD_CPU,
 		.title = "The Event subsystem has detected a slow cpu time process",
-		.description = "The Event subsystem has detected a slow process, this typically indicates that FRR is having trouble completing work in a timely manner.  This can be either a misconfiguration, bug, or some combination therof.  In this case total CPU time was over 5 seconds.  Which indicates that FRR is very busy doing some work and should be addressed",
+		.description = "The Event subsystem has detected a slow process, this typically indicates that FRR is having trouble completing work in a timely manner.  This can be either a misconfiguration, bug, or some combination thereof.  In this case total CPU time was over 5 seconds.  Which indicates that FRR is very busy doing some work and should be addressed",
 		.suggestion = "Gather log data and open an Issue",
 	},
 	{
 		.code = EC_LIB_SLOW_THREAD_WALL,
 		.title = "The Event subsystem has detected a slow wall time process",
-		.description = "The Event subsystem has detected a slow process, this typically indicates that FRR is having trouble completing work in a timely manner.  This can be either a misconfiguration, bug or some combination therof.  In this case total WALL time was over 5 seconds.  Which indicates that FRR might be having trouble being scheduled or some system call is delaying",
+		.description = "The Event subsystem has detected a slow process, this typically indicates that FRR is having trouble completing work in a timely manner.  This can be either a misconfiguration, bug or some combination thereof.  In this case total WALL time was over 5 seconds.  Which indicates that FRR might be having trouble being scheduled or some system call is delaying",
 		.suggestion = "Gather log data and open an Issue",
 	},
 	{
@@ -286,7 +286,7 @@ static struct log_ref ferr_lib_err[] = {
 	},
 	{
 		.code = EC_LIB_NB_CB_INVALID_PRIO,
-		.title = "Norhtbound callback has an invalid priority",
+		.title = "Northbound callback has an invalid priority",
 		.description = "The northbound subsystem, during initialization, has detected a callback whose priority is invalid",
 		.suggestion = "This is a bug; please report it"
 	},

lib/libospf.h

@@ -36,7 +36,7 @@ extern "C" {
 #define IPPROTO_OSPFIGP         89
 #endif /* IPPROTO_OSPFIGP */
 
-/* Architectual Constants */
+/* Architectural Constants */
 #ifdef DEBUG
 #define OSPF_LS_REFRESH_TIME                   120
 #else

lib/netns_linux.c

@@ -279,7 +279,7 @@ static void ns_disable_internal(struct ns *ns)
 	}
 }
 
-/* VRF list existance check by name. */
+/* VRF list existence check by name. */
 static struct ns_map_nsid *ns_map_nsid_lookup_by_nsid(ns_id_t ns_id)
 {
 	struct ns_map_nsid ns_map;

lib/prefix.c

@@ -113,7 +113,7 @@ const char *family2str(int family)
 	return "?";
 }
 
-/* Address Famiy Identifier to Address Family converter. */
+/* Address Family Identifier to Address Family converter. */
 int afi2family(afi_t afi)
 {
 	if (afi == AFI_IP)

lib/routemap.c

@@ -2480,7 +2480,7 @@ void route_map_notify_pentry_dependencies(const char *affected_name,
 			do whatever the exit policy (EXIT, NEXT or GOTO) tells.
      on-match next    - If this clause is matched, then the set statements
 			are executed and then we drop through to the next clause
-     on-match goto n  - If this clause is matched, then the set statments
+     on-match goto n  - If this clause is matched, then the set statements
 			are executed and then we goto the nth clause, or the
 			first clause greater than this. In order to ensure
 			route-maps *always* exit, you cannot jump backwards.

lib/sbuf.h

@@ -35,7 +35,7 @@ extern "C" {
  * without any information about the previous parsing steps, is usually not very
  * helpful.
  * Using sbuf, the parser can log the whole parsing process into a buffer using
- * a printf like API. When an error ocurrs, all the information about previous
+ * a printf like API. When an error occurs, all the information about previous
  * parsing steps is there in the log, without any need for backtracking, and can
  * be used to give a detailed and useful error description.
  * When parsing completes successfully without any error, the log can just be

lib/sigevent.c

@@ -96,7 +96,7 @@ int quagga_sigevent_process(void)
 	struct quagga_signal_t *sig;
 	int i;
 #ifdef SIGEVENT_BLOCK_SIGNALS
-	/* shouldnt need to block signals, but potentially may be needed */
+	/* shouldn't need to block signals, but potentially may be needed */
 	sigset_t newmask, oldmask;
 
 	/*
@@ -142,7 +142,7 @@ int quagga_sigevent_process(void)
 }
 
 #ifdef SIGEVENT_SCHEDULE_THREAD
-/* timer thread to check signals. Shouldnt be needed */
+/* timer thread to check signals. shouldn't be needed */
 int quagga_signal_timer(struct thread *t)
 {
 	struct quagga_sigevent_master_t *sigm;

lib/skiplist.c

@@ -21,7 +21,7 @@
  */
 
 /*
- * Skip List impementation based on code from William Pugh.
+ * Skip List implementation based on code from William Pugh.
  * ftp://ftp.cs.umd.edu/pub/skipLists/
  *
  * Skip Lists are a probabilistic alternative to balanced trees, as

lib/skiplist.h

@@ -21,7 +21,7 @@
  */
 
 /*
- * Skip List impementation based on code from William Pugh.
+ * Skip List implementation based on code from William Pugh.
  * ftp://ftp.cs.umd.edu/pub/skipLists/
  */