Merge pull request #10563 from luzpaz/typos/opal

Fix typos in the opal/ subdirectory

Author: jsquyres

opal/class/opal_bitmap.h

@@ -83,7 +83,7 @@ OPAL_DECLSPEC int opal_bitmap_init(opal_bitmap_t *bm, int size);
 
 /**
  * Set a bit of the bitmap. If the bit asked for is beyond the current
- * size of the bitmap, then the bitmap is extended to accomodate the
+ * size of the bitmap, then the bitmap is extended to accommodate the
  * bit
  *
  * @param  bitmap The input bitmap (IN)

opal/class/opal_cstring.h

@@ -137,7 +137,7 @@ int opal_cstring_to_int(opal_cstring_t *string, int *interp);
  * @retval OPAL_SUCCESS string was successfully interpreted
  * @retval OPAL_ERR_BAD_PARAM string was not able to be interpreted
  *
- *   The string value will be cast to the boolen output in
+ *   The string value will be cast to the boolean output in
  *   the following manner:
  *
  *   - If the string value is digits, the return value is "(bool)

opal/class/opal_fifo.h

@@ -13,7 +13,7 @@
  * Copyright (c) 2007      Voltaire All rights reserved.
  * Copyright (c) 2010      IBM Corporation.  All rights reserved.
  * Copyright (c) 2014-2018 Los Alamos National Security, LLC. All rights
- *                         reseved.
+ *                         reserved.
  * Copyright (c) 2021      Triad National Security, LLC. All rights reserved.
  * Copyright (c) 2021      Google, LLC. All rights reserved.
  * $COPYRIGHT$
@@ -222,7 +222,7 @@ static inline opal_list_item_t *opal_fifo_pop_atomic(opal_fifo_t *fifo)
     /* use load-linked store-conditional to avoid ABA issues */
     do {
         if (++attempt == 5) {
-            /* deliberatly suspend this thread to allow other threads to run. this should
+            /* deliberately suspend this thread to allow other threads to run. this should
              * only occur during periods of contention on the lifo. */
             _opal_lifo_release_cpu();
             attempt = 0;

opal/class/opal_free_list.h

@@ -175,13 +175,13 @@ OPAL_DECLSPEC int opal_free_list_grow_st(opal_free_list_t *flist, size_t num_ele
 OPAL_DECLSPEC int opal_free_list_resize_mt(opal_free_list_t *flist, size_t size);
 
 /**
- * Attemp to obtain an item from a free list.
+ * Attempt to obtain an item from a free list.
  *
  * @param fl (IN)        Free list.
  * @param item (OUT)     Allocated item.
  *
  * If the requested item is not available the free list is grown to
- * accomodate the request - unless the max number of allocations has
+ * accommodate the request - unless the max number of allocations has
  * been reached.  If this is the case - a NULL pointer is returned
  * to the caller. This function comes in three flavor: thread safe
  * (opal_free_list_get_mt), single threaded (opal_free_list_get_st),
@@ -230,7 +230,7 @@ static inline opal_free_list_item_t *opal_free_list_get(opal_free_list_t *flist)
  * @param item (OUT)     Allocated item.
  *
  * If the requested item is not available the free list is grown to
- * accomodate the request - unless the max number of allocations has
+ * accommodate the request - unless the max number of allocations has
  * been reached. In this case the caller is blocked until an item
  * is returned to the list.
  */
@@ -259,8 +259,8 @@ static inline opal_free_list_item_t *opal_free_list_wait_mt(opal_free_list_t *fl
                 }
             }
         } else {
-            /* If I wasn't able to get the lock in the begining when I finaly grab it
-             * the one holding the lock in the begining already grow the list. I will
+            /* If I wasn't able to get the lock in the beginning when I finally grab it
+             * the one holding the lock in the beginning already grow the list. I will
              * release the lock and try to get a new element until I succeed.
              */
             opal_mutex_lock(&fl->fl_lock);

opal/class/opal_graph.c

@@ -627,7 +627,7 @@ uint32_t opal_graph_dijkstra(opal_graph_t *graph, opal_graph_vertex_t *vertex,
     /* run on all the vertices of the graph */
     i = 0;
     OPAL_LIST_FOREACH (adj_list, graph->adjacency_list, opal_adjacency_list_t) {
-        /* insert the vertices pointes to the working queue */
+        /* insert the vertices points to the working queue */
         Q[i].vertex = adj_list->vertex;
         /**
          * assign an infinity distance to all the vertices in the queue
@@ -677,7 +677,7 @@ uint32_t opal_graph_dijkstra(opal_graph_t *graph, opal_graph_vertex_t *vertex,
 
 /**
  * This graph API duplicates a graph. Note that this API does
- * not copy the graph but builds a new graph while coping just
+ * not copy the graph but builds a new graph while copying just
  * the vertex data.
  *
  * @param dest The new created graph.

opal/class/opal_graph.h

@@ -19,7 +19,7 @@
 /**
  * @file
  * The opal_graph interface is used to provide a generic graph infrastructure
- * to Open-MPI. The graph is represented as an adjacentcy list.
+ * to Open-MPI. The graph is represented as an adjacency list.
  * The graph is a list of vertices. The graph is a weighted directional graph.
  * Each vertex contains a pointer to a vertex data.
  * This pointer can point to the structure that this vertex belongs to.
@@ -53,7 +53,7 @@ OPAL_DECLSPEC OBJ_CLASS_DECLARATION(opal_adjacency_list_t);
 OPAL_DECLSPEC OBJ_CLASS_DECLARATION(opal_graph_t);
 
 /**
- * Function pointer for coping a vertex data from one vertex to
+ * Function pointer for copying a vertex data from one vertex to
  * another
  *
  * @param dst The destination pointer of vertex_data
@@ -83,7 +83,7 @@ typedef void *(*opal_graph_alloc_vertex_data)(void);
  *@param vertex_data1
  *@param vertex_data2
  *
- *@return int The comparition results. 1- vertex_data1 is bigger
+ *@return int The comparison results. 1- vertex_data1 is bigger
  *        then vertex_data2, 0- vertex_data1 is equal to
  *        vertex_data2 and -1- vertex_data1 is smaller the
  *        vertex_data2.
@@ -310,7 +310,7 @@ OPAL_DECLSPEC int opal_graph_get_adjacent_vertices(opal_graph_t *graph, opal_gra
 
 /**
  * This graph API duplicates a graph. Note that this API does
- * not copy the graph but builds a new graph while coping just
+ * not copy the graph but builds a new graph while copying just
  * the vertices data.
  *
  * @param dest The new created graph.

opal/class/opal_hash_table.c

@@ -37,7 +37,7 @@
  * Sketch: [Contributed by David Linden of Hewlett-Packard]
  *
  * This has been found to be good for search and insert and
- * (seldom-)remove, all with probablistic O(1) time.  Having a good
+ * (seldom-)remove, all with probabilistic O(1) time.  Having a good
  * distribution of the hash indices is important, so even if you know
  * the keys distribute well under a mask, that micro-optimization
  * isn't worth doing.
@@ -299,7 +299,7 @@ opal_hash_table_remove_elt_at(opal_hash_table_t *ht, size_t ii)
                 /* already in place, either ideal or best-for-now */
                 break;
             } else if (!elts[jj].valid) {
-                /* move it down, and invaildate where it came from */
+                /* move it down, and invalidate where it came from */
                 elts[jj] = elts[ii];
                 elts[ii].valid = 0;
                 break;

opal/class/opal_hotel.h

@@ -154,7 +154,7 @@ OBJ_CLASS_DECLARATION(opal_hotel_t);
  * already been ("forcibly") checked out *before* the
  * eviction_callback_fn is invoked.
  *
- * @return OPAL_SUCCESS if all initializations were succesful. Otherwise,
+ * @return OPAL_SUCCESS if all initializations were successful. Otherwise,
  *  the error indicate what went wrong in the function.
  */
 OPAL_DECLSPEC int opal_hotel_init(opal_hotel_t *hotel, int num_rooms, opal_event_base_t *evbase,

opal/class/opal_interval_tree.c

@@ -87,7 +87,7 @@ static void opal_interval_tree_construct(opal_interval_tree_t *tree)
     tree->reader_count = 0;
     tree->epoch = 0;
 
-    /* set all reader epochs to UINT_MAX. this value is used to simplfy
+    /* set all reader epochs to UINT_MAX. this value is used to simplify
      * checks against the current epoch. */
     for (int i = 0; i < OPAL_INTERVAL_TREE_MAX_READERS; ++i) {
         tree->reader_epochs[i] = UINT_MAX;
@@ -788,7 +788,7 @@ static opal_interval_tree_node_t *left_rotate(opal_interval_tree_t *tree,
 
     rp_publish(&y->left, x_copy);
 
-    /* normlly we would have to check to see if we are at the root.
+    /* normally we would have to check to see if we are at the root.
      * however, the root sentinal takes care of it for us */
     if (x == parent->left) {
         rp_publish(&parent->left, y);

opal/class/opal_interval_tree.h

@@ -114,7 +114,7 @@ typedef int (*opal_interval_tree_condition_fn_t)(void *);
 typedef int (*opal_interval_tree_action_fn_t)(uint64_t low, uint64_t high, void *data, void *ctx);
 
 /*
- * Public function protoypes
+ * Public function prototypes
  */
 
 /**
@@ -189,7 +189,7 @@ OPAL_DECLSPEC int opal_interval_tree_destroy(opal_interval_tree_t *tree);
  * @param tree a pointer to the tree
  * @param low low value of interval
  * @param high high value of interval
- * @param partial_ok traverse nodes that parially overlap the given range
+ * @param partial_ok traverse nodes that partially overlap the given range
  * @param action a pointer to the action function
  * @param ctx context to pass to action function
  *
@@ -205,7 +205,7 @@ OPAL_DECLSPEC int opal_interval_tree_traverse(opal_interval_tree_t *tree, uint64
  *
  * @param tree a pointer to the tree data structure
  *
- * @retval int the nuber of items on the tree
+ * @retval int the number of items on the tree
  */
 OPAL_DECLSPEC size_t opal_interval_tree_size(opal_interval_tree_t *tree);