Fixed Spelling Errors (#1166)

* fixed missed closing of a dataset

* fixed missed closing of a dataset

* fixed typo in error return

* Committing clang-format changes

* minor edits

* code format

* Committing clang-format changes

* code format

* minor edit

* switched from using MPI_count, to actual bytes written for H5FD_mpio_debug rw debugging

* Committing clang-format changes

* changed size_i in printf to reflect the I/O.

* Committing clang-format changes

* Fixed seg fault with xlf on BE with -qintsize=8

* fixed error function string

* spelling corrections via codespell, added new spell check github actions

* Committing clang-format changes

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* misc

* Committing clang-format changes

* misc

* misc

* misc

* misc

* misc

* misc

* Committing clang-format changes

* misc

* work around for https://github.com/codespell-project/codespell/issues/2137

* misc

* added missing file

* misc

* misc.

* misc

* switch to using Codespell with GitHub Actions

* misc.

* misc.

* fixed more sp errors

* Fix new typos found by codespell.

* fixed proceed with precede

* fixed variable in fortran test

* fixed minnum

* updated spelling list

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Larry Knox <lrknox@hdfgroup.org>

11 files changed, 28 insertions, 28 deletions

diff --git a/tools/lib/h5diff.c b/tools/lib/h5diff.c
index 74db58f..debd54a 100644
--- a/tools/lib/h5diff.c
+++ b/tools/lib/h5diff.c
@@ -1232,7 +1232,7 @@ diff_match(hid_t file1_id, const char *grp1, trav_info_t *info1, hid_t file2_id,
                     H5TOOLS_DEBUG("Beginning of big else block");
                     /* We're in parallel mode */
                     /* Since the data type of diff value is hsize_t which can
-                     * be arbitary large such that there is no MPI type that
+                     * be arbitrary large such that there is no MPI type that
                      * matches it, the value is passed between processes as
                      * an array of bytes in order to be portable.  But this
                      * may not work in non-homogeneous MPI environments.
diff --git a/tools/lib/h5diff.h b/tools/lib/h5diff.h
index 8d7ac13..4afb3f6 100644
--- a/tools/lib/h5diff.h
+++ b/tools/lib/h5diff.h
@@ -74,7 +74,7 @@ typedef struct {
     struct exclude_path_list *exclude_attr;       /* keep exclude attribute list */
     int                       count_bool;         /* count, compare up to count */
     hsize_t                   count;              /* count value */
-    diff_err_t                err_stat;  /* an error ocurred (2, error, 1, differences, 0, no error) */
+    diff_err_t                err_stat;  /* an error occurred (2, error, 1, differences, 0, no error) */
     hsize_t                   nelmts;    /* total number of elements */
     hsize_t                   hs_nelmts; /* number of elements to read at a time*/
     int                       rank;      /* dimensionality */
diff --git a/tools/lib/h5tools.h b/tools/lib/h5tools.h
index dde4026..cc6183a 100644
--- a/tools/lib/h5tools.h
+++ b/tools/lib/h5tools.h
@@ -240,7 +240,7 @@ typedef struct h5tool_format_t {
      *
      *   fmt_schar:  The printf() format to use when rendering data which is
      *               typed `signed char'. The default is `%d'. This format is
-     *               used ony if the `ascii' field is zero.
+     *               used only if the `ascii' field is zero.
      *
      *   fmt_uchar:  The printf() format to use when rendering data which is
      *               typed `unsigned char'. The default is `%u'. This format
@@ -411,9 +411,9 @@ typedef struct h5tool_format_t {
      *   sep:       Each integer in the index list will be separated from the
      *              others by this string, which defaults to a comma.
      *
-     *   fmt:       After the index values are formated individually and
+     *   fmt:       After the index values are formatted individually and
      *              separated from one another by some string, the entire
-     *              resulting string will be formated according to this
+     *              resulting string will be formatted according to this
      *              printf(3c) format which should include a format for a
      *              character string.  The default is "%s".
      */
@@ -483,7 +483,7 @@ typedef struct h5tool_format_t {
     const char *line_suf;       /*string to append to each line */
     const char *line_sep;       /*separates lines               */
     int         line_multi_new; /*split multi-line outputs?     */
-    const char *line_indent;    /*for extra identation if we need it*/
+    const char *line_indent;    /*for extra indentation if we need it*/
 
     /*used to skip the first set of checks for line length*/
     int skip_first;
@@ -606,7 +606,7 @@ typedef enum {
 } driver_idx;
 
 /* The following include, h5tools_str.h, must be after the
- * above stucts are defined. There is a dependency in the following
+ * above structs are defined. There is a dependency in the following
  * include that hasn't been identified yet. */
 
 #include "h5tools_str.h"
diff --git a/tools/lib/h5tools_dump.c b/tools/lib/h5tools_dump.c
index cb4f9d2..0fc5d2d 100644
--- a/tools/lib/h5tools_dump.c
+++ b/tools/lib/h5tools_dump.c
@@ -478,7 +478,7 @@ done:
  *      This is a special case subfunction to print the data in a region reference of type blocks.
  *
  * Return:
- *      The function returns FAIL if there was an error, otherwise SUCEED
+ *      The function returns FAIL if there was an error, otherwise SUCCEED
  *
  * Parameters Description:
  *      h5tools_str_t *buffer is the string into which to render
@@ -500,7 +500,7 @@ h5tools_print_region_data_blocks(hid_t region_id, FILE *stream, const h5tool_for
     hsize_t *         count           = NULL;
     hsize_t           blkndx;
     hsize_t           total_size[H5S_MAX_RANK];
-    hsize_t           elmtno; /* elemnt index  */
+    hsize_t           elmtno; /* element index  */
     hsize_t           curr_pos = 0;
     unsigned int      region_flags; /* buffer extent flags */
     hsize_t           numelem;
@@ -896,7 +896,7 @@ h5tools_print_region_data_points(hid_t region_space, hid_t region_id, FILE *stre
 {
     hbool_t           dimension_break = TRUE;
     hsize_t *         dims1           = NULL;
-    hsize_t           elmtno; /* elemnt index  */
+    hsize_t           elmtno; /* element index  */
     hsize_t           curr_pos = 0;
     hsize_t           total_size[H5S_MAX_RANK];
     hsize_t           jndx;
@@ -1286,7 +1286,7 @@ h5tools_print_simple_subset(FILE *stream, const h5tool_format_t *info, h5tools_c
 
     H5TOOLS_START_DEBUG(" ");
     if ((size_t)ctx->ndims > NELMTS(sm_size))
-        H5TOOLS_THROW(FAIL, "ndims and sm_size comparision failed");
+        H5TOOLS_THROW(FAIL, "ndims and sm_size comparison failed");
 
     size_row_block = ctx->sset->block.data[row_dim];
 
@@ -3340,7 +3340,7 @@ h5tools_dump_dcpl(FILE *stream, const h5tool_format_t *info, h5tools_context_t *
         } break;
 
         case H5D_VIRTUAL: {
-            char   dsetname[256]; /* virtual datset name       */
+            char   dsetname[256]; /* virtual dataset name       */
             size_t n_vmaps;
 
             H5Pget_virtual_count(dcpl_id, &n_vmaps);
diff --git a/tools/lib/h5tools_ref.c b/tools/lib/h5tools_ref.c
index 50f283d..1c97a52 100644
--- a/tools/lib/h5tools_ref.c
+++ b/tools/lib/h5tools_ref.c
@@ -70,7 +70,7 @@ free_ref_path_info(void *item, void H5_ATTR_UNUSED *key, void H5_ATTR_UNUSED *op
 /*-------------------------------------------------------------------------
  * Function:    init_ref_path_cb
  *
- * Purpose:     Called by interator to create references for
+ * Purpose:     Called by iterator to create references for
  *              all objects and enter them in the table.
  *
  * Return:      Error status.
@@ -123,7 +123,7 @@ ref_path_table_cmp(const void *key1, const void *key2)
 /*-------------------------------------------------------------------------
  * Function:    init_ref_path_table
  *
- * Purpose:     Initalize the reference path table
+ * Purpose:     Initialize the reference path table
  *
  * Return:      Non-negative on success, negative on failure
  *
@@ -377,7 +377,7 @@ lookup_ref_path(H5R_ref_t refbuf)
 /*-------------------------------------------------------------------------
  * Function:    fill_ref_path_table
  *
- * Purpose:     Called by interator to create references for
+ * Purpose:     Called by iterator to create references for
  *              all objects and enter them in the table.
  *
  * Return:      Error status.
diff --git a/tools/lib/h5tools_str.c b/tools/lib/h5tools_str.c
index 3cd12bb..4e8dcc1 100644
--- a/tools/lib/h5tools_str.c
+++ b/tools/lib/h5tools_str.c
@@ -129,7 +129,7 @@ h5tools_str_append(h5tools_str_t *str /*in,out*/, const char *fmt, ...)
 
         /* Note: HDvsnprintf() behaves differently on Windows as Unix, when
          * buffer is smaller than source string. On Unix, this function
-         * returns length of the source string and copy string upto the
+         * returns length of the source string and copy string up to the
          * buffer size with NULL at the end of the buffer. However on
          * Windows with the same condition, this function returns -1 and
          * doesn't add NULL at the end of the buffer.
@@ -147,7 +147,7 @@ h5tools_str_append(h5tools_str_t *str /*in,out*/, const char *fmt, ...)
              * following conditions, each of which indicates that the proper C99 return value probably
              *  should have been positive when the format string is
              *  something other than "%s"
-             * Alocate at least twice as much space and try again.
+             * Allocate at least twice as much space and try again.
              */
             size_t newsize = MAX(str->len + (size_t)nchars + 1, 2 * str->nalloc);
             HDassert(newsize > str->nalloc); /*overflow*/
@@ -1246,7 +1246,7 @@ h5tools_str_sprint(h5tools_str_t *str, const h5tool_format_t *info, hid_t contai
 
                 /* Print the closing bracket */
                 h5tools_str_append(str, "%s", OPT(info->arr_suf, "]"));
-                is_next_arry_elmt = 1; /* set for begining of next array element */
+                is_next_arry_elmt = 1; /* set for beginning of next array element */
                 H5Tclose(memb);
             } break;
 
@@ -1504,7 +1504,7 @@ h5tools_str_is_zero(const void *_mem, size_t size)
  *              March 8, 2012
  *
  * Notes:
- *   Applications need to call free() to free the memoery allocated for
+ *   Applications need to call free() to free the memory allocated for
  *   the return string
  *
  *-------------------------------------------------------------------------
diff --git a/tools/lib/h5tools_utils.c b/tools/lib/h5tools_utils.c
index ea9812b..66d3ef6 100644
--- a/tools/lib/h5tools_utils.c
+++ b/tools/lib/h5tools_utils.c
@@ -180,7 +180,7 @@ help_ref_msg(FILE *output)
  *     * Last two characters in the string MUST be ")\0".
  *
  *     * Generates a copy of the input string `start`, (src..")\0"), replacing
- *       separators and close-paren with null charaters.
+ *       separators and close-paren with null characters.
  *         * This string is allocated at runtime and should be freed when done.
  *     * Generates array of char pointers, and directs start of each element
  *       (each pointer) into this copy.
@@ -227,7 +227,7 @@ parse_tuple(const char *start, int sep, char **cpy_out, unsigned *nelems, char *
     char *   elem_ptr    = NULL;
     char *   dest_ptr    = NULL;
     unsigned elems_count = 0;
-    char **  elems       = NULL; /* more like *elems[], but complier... */
+    char **  elems       = NULL; /* more like *elems[], but compiler... */
     char **  elems_re    = NULL; /* temporary pointer, for realloc */
     char *   cpy         = NULL;
     herr_t   ret_value   = SUCCEED;
@@ -337,7 +337,7 @@ parse_tuple(const char *start, int sep, char **cpy_out, unsigned *nelems, char *
             /* Found terminal, non-escaped close-paren. Last element.
              * Write null terminator to copy.
              * Advance source pointer to gently break from loop.
-             * Requred to prevent ")" from always being added to last element.
+             * Required to prevent ")" from always being added to last element.
              */
             start++;
         }
diff --git a/tools/lib/h5tools_utils.h b/tools/lib/h5tools_utils.h
index 095ad6c..3733742 100644
--- a/tools/lib/h5tools_utils.h
+++ b/tools/lib/h5tools_utils.h
@@ -100,7 +100,7 @@ typedef enum toolname_t {
     TOOL__H5DUMP /* add as necessary */
 } h5tool_toolname_t;
 
-/* this struct can be used to differntiate among tools */
+/* this struct can be used to differentiate among tools */
 typedef struct {
     h5tool_toolname_t toolname;
     int               msg_mode;
diff --git a/tools/lib/h5trav.c b/tools/lib/h5trav.c
index d0c299f..1f4b0d6 100644
--- a/tools/lib/h5trav.c
+++ b/tools/lib/h5trav.c
@@ -534,7 +534,7 @@ trav_info_free(trav_info_t *info)
 /*-------------------------------------------------------------------------
  * Function: trav_table_visit_obj
  *
- * Purpose: Callback for visiting object, with 'table' sructure
+ * Purpose: Callback for visiting object, with 'table' structure
  *
  * Return:   0 on success,
  *          -1 on failure
@@ -559,7 +559,7 @@ trav_table_visit_obj(const char *path, const H5O_info2_t *oinfo, const char *alr
 /*-------------------------------------------------------------------------
  * Function: trav_table_visit_lnk
  *
- * Purpose:  Callback for visiting link, with 'table' sructure
+ * Purpose:  Callback for visiting link, with 'table' structure
  *
  * Return:   0 on success,
  *          -1 on failure
@@ -1127,7 +1127,7 @@ symlink_is_visited(symlink_trav_t *visited, H5L_type_t type, const char *file, c
     /* Look for symlink */
     for (u = 0; u < visited->nused; u++) {
         /* Check for symlink values already in array */
-        /* check type and path pair to distingush between symbolic links */
+        /* check type and path pair to distinguish between symbolic links */
         if ((visited->objs[u].type == type) && !HDstrcmp(visited->objs[u].path, path)) {
             /* if external link, file need to be matched as well */
             if (visited->objs[u].type == H5L_TYPE_EXTERNAL)
diff --git a/tools/lib/h5trav.h b/tools/lib/h5trav.h
index 7a8a63d..58d347d 100644
--- a/tools/lib/h5trav.h
+++ b/tools/lib/h5trav.h
@@ -87,7 +87,7 @@ typedef struct trav_link_t {
 } trav_link_t;
 
 /*-------------------------------------------------------------------------
- * struct to store basic info needed for the h5trav table traversal algorythm
+ * struct to store basic info needed for the h5trav table traversal algorithm
  *-------------------------------------------------------------------------
  */
 
diff --git a/tools/lib/io_timer.c b/tools/lib/io_timer.c
index aec7e9b..ce21b3e 100644
--- a/tools/lib/io_timer.c
+++ b/tools/lib/io_timer.c
@@ -11,7 +11,7 @@
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 /* changes:
  * rename pio_timer.c as io_timer.c;
- * Removed pio_perf.h so that it is not dependant on it;
+ * Removed pio_perf.h so that it is not dependent on it;
  * Removed set_timer_type() and get_timer_type() since no one calls them;
  * Merged sio_timer.c into io_timer.c;
  */