[PATCH] comments typos

[Martijn Dekker <martijn@xxxxxxxx>]

And finally, codespell helped me find a bunch of typos in the comments 
in Src/ and Test/.

This patch does not change any code. In Test/, it does fix typos in the 
titles of some tests.

- M.

--
modernish -- harness the shell
https://github.com/modernish/modernish

diff --git a/Src/builtin.c b/Src/builtin.c
index 18daad4fa..bd7736d2c 100644
--- a/Src/builtin.c
+++ b/Src/builtin.c
@@ -1718,7 +1718,7 @@ fcsubs(char **sp, struct asgment *sub)
 	newstr = sub->value.scalar;
 	sub = (Asgment)sub->node.next;
 	oldpos = s;
-	/* loop over occurences of oldstr in s, replacing them with newstr */
+	/* loop over occurrences of oldstr in s, replacing them with newstr */
 	while ((newpos = (char *)strstr(oldpos, oldstr))) {
 	    newmem = (char *) zhalloc(1 + (newpos - s)
 				      + strlen(newstr) + strlen(newpos + strlen(oldstr)));
@@ -2526,7 +2526,7 @@ typeset_single(char *cname, char *pname, Param pm, UNUSED(int func),
 		 * Attempt to assign a scalar value to an array.
 		 * This can happen if the array is special.
 		 * We'll be lenient and guess what the user meant.
-		 * This is how normal assigment works.
+		 * This is how normal assignment works.
 		 */
 		if (*asg->value.scalar) {
 		    /* Array with one value */
diff --git a/Src/compat.c b/Src/compat.c
index 02b66a780..8ab335aa1 100644
--- a/Src/compat.c
+++ b/Src/compat.c
@@ -30,8 +30,8 @@
 #include "zsh.mdh"
 #include "compat.pro"
 
-/* Return pointer to first occurence of string t *
- * in string s.  Return NULL if not present.     */
+/* Return pointer to first occurrence of string t *
+ * in string s.  Return NULL if not present.      */
 
 /**/
 #ifndef HAVE_STRSTR
diff --git a/Src/exec.c b/Src/exec.c
index 6014ec9a5..9dc91a71e 100644
--- a/Src/exec.c
+++ b/Src/exec.c
@@ -4299,7 +4299,7 @@ save_params(Estate state, Wordcode pc, LinkList *restore_p, LinkList *remove_p)
 		       (unset(RESTRICTED) || !(pm->node.flags & PM_RESTRICTED))) {
 		/*
 		 * In this case we're just saving parts of
-		 * the parameter in a tempory, so use heap allocation
+		 * the parameter in a temporary, so use heap allocation
 		 * and don't bother copying every detail.
 		 */
 		tpm = (Param) hcalloc(sizeof *tpm);
diff --git a/Src/glob.c b/Src/glob.c
index 92fd64e7c..a367b082b 100644
--- a/Src/glob.c
+++ b/Src/glob.c
@@ -274,7 +274,7 @@ addpath(char *s, int l)
 }
 
 /* stat the filename s appended to pathbuf.  l should be true for lstat,    *
- * false for stat.  If st is NULL, the file is only checked for existance.  *
+ * false for stat.  If st is NULL, the file is only checked for existence.  *
  * s == "" is treated as s == ".".  This is necessary since on most systems *
  * foo/ can be used to reference a non-directory foo.  Returns nonzero if   *
  * the file does not exists.                                                */
@@ -566,7 +566,7 @@ scanner(Complist q, int shortcircuit)
 		continue;
 	    errsfound = errssofar;
 	    if (pattry(p, fn)) {
-		/* if this name matchs the pattern... */
+		/* if this name matches the pattern... */
 		if (pbcwdsav == pathbufcwd &&
 		    strlen(fn) + pathpos - pathbufcwd >= PATH_MAX) {
 		    int err;
diff --git a/Src/hashtable.c b/Src/hashtable.c
index b7baa3142..e210ddeca 100644
--- a/Src/hashtable.c
+++ b/Src/hashtable.c
@@ -996,7 +996,7 @@ printshfuncnode(HashNode hn, int printflags)
  * expansion of leading tabs.
  * expand = 0 is standard: use hard tabs.
  * expand > 0 uses that many spaces.
- * expand < 0 uses no identation.
+ * expand < 0 uses no indentation.
  *
  * Note this function and the following two are called with
  * interrupts queued, so saving and restoring text_expand_tabs
diff --git a/Src/hist.c b/Src/hist.c
index e47be8e15..74116e82f 100644
--- a/Src/hist.c
+++ b/Src/hist.c
@@ -181,7 +181,7 @@ mod_export char *chline;
  * To avoid having to modify this every time we modify chline,
  * we set it when we push the stack, and unset it when we pop
  * the appropriate value off the stack.  As it's never modified
- * on the stack this is the only maintainance we ever do on it.
+ * on the stack this is the only maintenance we ever do on it.
  * In return, ZLE has to check both zle_chline and (if that's
  * NULL) chline to get the current value.
  */
@@ -476,7 +476,7 @@ herrflush(void)
      *
      * Note that this is a side effect --- this is not the usual reason
      * for testing lex_add_raw which is to add the text to a different
-     * buffer used when we are actually parsing the command substituion
+     * buffer used when we are actually parsing the command substitution
      * (nothing to do with ZLE).  Sorry.
      */
     while (inbufct && (!strin || lex_add_raw)) {
diff --git a/Src/init.c b/Src/init.c
index 445cd3937..2306d7bdf 100644
--- a/Src/init.c
+++ b/Src/init.c
@@ -137,7 +137,7 @@ loop(int toplevel, int justonce)
 		else
 		    stophist = hstop;
 		/*
-		 * Reset all errors, including user interupts.
+		 * Reset all errors, including user interrupts.
 		 * This is what allows ^C in an interactive shell
 		 * to return us to the command line.
 		 */
@@ -203,7 +203,7 @@ loop(int toplevel, int justonce)
 		 * that would be inconsistent with the case where
 		 * we didn't execute a preexec function.  This is
 		 * an implementation detail that an interrupting user
-		 * does't care about.
+		 * doesn't care about.
 		 */
 		errflag &= ~ERRFLAG_ERROR;
 	    }
@@ -362,7 +362,7 @@ static void parseopts_setemulate(char *nam, int flags)
  * Parse shell options.
  *
  * If (flags & PARSEARGS_TOPLEVEL):
- * - we are doing shell initilisation
+ * - we are doing shell initialisation
  * - nam is the name under which the shell was started
  * - set up emulation and standard options based on that.
  * Otherwise:
diff --git a/Src/jobs.c b/Src/jobs.c
index c06cb9c79..e7438251e 100644
--- a/Src/jobs.c
+++ b/Src/jobs.c
@@ -1085,7 +1085,7 @@ printjob(Job jn, int lng, int synch)
 	{
 	    /*
 	     * A subjob still has process, which must finish before
-	     * further excution of the superjob, which the user wants to
+	     * further execution of the superjob, which the user wants to
 	     * know about.  So report the status of the subjob as if it
 	     * were the user-visible superjob.
 	     */
diff --git a/Src/lex.c b/Src/lex.c
index f43bcc7db..1d86da94e 100644
--- a/Src/lex.c
+++ b/Src/lex.c
@@ -2109,7 +2109,7 @@ skipcomm(void)
 	hist_in_word(1);
     } else {
 	/*
-	 * Set up for nested command subsitution, however
+	 * Set up for nested command substitution, however
 	 * we don't actually need the string until we get
 	 * back to the top level and recover the lot.
 	 * The $() body just appears empty.
diff --git a/Src/main.c b/Src/main.c
index 30eef5a25..bad698ee7 100644
--- a/Src/main.c
+++ b/Src/main.c
@@ -34,7 +34,7 @@
  * Support for Cygwin binary/text mode filesystems.
  * Peter A. Castro <doctor@xxxxxxxxxxxx>
  *
- * This deserves some explaination, because it uses Cygwin specific
+ * This deserves some explanation, because it uses Cygwin specific
  * runtime functions.
  *
  * Cygwin supports the notion of binary or text mode access to files
@@ -43,7 +43,7 @@
  * and all.  If it's on a text mounted filesystem, Cygwin will strip out
  * the CRs.  This presents a problem because zsh code doesn't allow for
  * CRLF's as line terminators.  So, we must force all open files to be
- * in text mode reguardless of the underlying filesystem attributes.
+ * in text mode regardless of the underlying filesystem attributes.
  * However, we only want to do this for reading, not writing as we still
  * want to write files in the mode of the filesystem.  To do this,
  * we have two options: augment all {f}open() calls to have O_TEXT added to
diff --git a/Src/mem.c b/Src/mem.c
index 77e4375f0..5951e57ed 100644
--- a/Src/mem.c
+++ b/Src/mem.c
@@ -1120,7 +1120,7 @@ struct m_hdr {
 /* length of memory header, length of first field of memory header and
    minimal size of a block left free (if we allocate memory and take a
    block from the free list that is larger than needed, it must have at
-   least M_MIN extra bytes to be splitted; if it has, the rest is put on
+   least M_MIN extra bytes to be split; if it has, the rest is put on
    the free list) */
 
 #define M_HSIZE (sizeof(struct m_hdr))
diff --git a/Src/module.c b/Src/module.c
index 33d75ebbd..f41b82f25 100644
--- a/Src/module.c
+++ b/Src/module.c
@@ -442,7 +442,7 @@ add_autobin(const char *module, const char *bnam, int flags)
 }
 
 /* Remove the builtin added previously by addbuiltin().  Returns *
- * zero on succes and -1 if there is no builtin with that name.  */
+ * zero on success and -1 if there is no builtin with that name. */
 
 /**/
 int
diff --git a/Src/params.c b/Src/params.c
index a253a9d8e..da7a6b4c5 100644
--- a/Src/params.c
+++ b/Src/params.c
@@ -3548,7 +3548,7 @@ setiparam(char *s, zlong val)
 
 /*
  * Set an integer parameter without forcing creation of an integer type.
- * This is useful if the integer is going to be set to a parmaeter which
+ * This is useful if the integer is going to be set to a parameter which
  * would usually be scalar but may not exist.
  */
 
diff --git a/Src/parse.c b/Src/parse.c
index 53709ac00..de1b27967 100644
--- a/Src/parse.c
+++ b/Src/parse.c
@@ -1811,7 +1811,7 @@ par_simple(int *cmplx, int nr)
 	    for (ptr = str; *ptr; ptr++) {
 		/*
 		 * We can't treat this as "simple" if it contains
-		 * expansions that require process subsitution, since then
+		 * expansions that require process substitution, since then
 		 * we need process handling.
 		 */
 		if (ptr[1] == Inpar &&
diff --git a/Src/pattern.c b/Src/pattern.c
index 97d488a31..95e5a79a0 100644
--- a/Src/pattern.c
+++ b/Src/pattern.c
@@ -156,7 +156,7 @@ typedef union upat *Upat;
  *    P_BRANCH, but applies to the immediately preceding branch.  The code in
  *    the corresponding branch is followed by a P_EXCSYNC, which simply
  *    acts as a marker that a P_EXCLUDE comes next.  The P_EXCLUDE
- *    has a pointer to char embeded in it, which works
+ *    has a pointer to char embedded in it, which works
  *    like P_WBRANCH:  if we get to the P_EXCSYNC, and we already matched
  *    up to the same position, fail.  Thus we are forced to backtrack
  *    on closures in the P_BRANCH if the first attempt was excluded.
@@ -502,7 +502,7 @@ patcompcharsset(void)
     }
 }
 
-/* Called before parsing a set of file matchs to initialize flags */
+/* Called before parsing a set of file matches to initialize flags */
 
 /**/
 void
@@ -2082,7 +2082,7 @@ patmungestring(char **string, int *stringlen, int *unmetalenin)
 }
 
 /*
- * Allocate memeory for pattern match.  Note this is specific to use
+ * Allocate memory for pattern match.  Note this is specific to use
  * of pattern *and* trial string.
  *
  * Unmetafy a trial string for use in pattern matching, if needed.
@@ -2103,7 +2103,7 @@ patmungestring(char **string, int *stringlen, int *unmetalenin)
  * In patstralloc (supplied by caller, must last until last pattry is done)
  *  unmetalen is the unmetafied length of the string; it will be
  *    calculated if the input value is negative.
- *  unmetalenp is the umetafied length of a path segment preceeding
+ *  unmetalenp is the umetafied length of a path segment preceding
  *    the trial string needed for file mananagement; it is calculated as
  *    needed so does not need to be initialised.
  *  alloced is the memory allocated on the heap --- same as return value from
@@ -2237,7 +2237,7 @@ pattrylen(Patprog prog, char *string, int len, int unmetalen,
  * depends on both prog *and* the trial string).  This should only be
  * done if there is no path prefix (pathpos == 0) as otherwise the path
  * buffer and unmetafied string may not match.  To do this,
- * patallocstr() is callled (use force = 1 to ensure it is alway
+ * patallocstr() is called (use force = 1 to ensure it is always
  * unmetafied); paststralloc points to existing storage. Memory is
  * on the heap.
  *
@@ -2331,7 +2331,7 @@ pattryrefs(Patprog prog, char *string, int stringlen, int unmetalenin,
 	if (patstralloc->alloced)
 	{
 	    /*
-	     * Unmetafied; we need pattern sring that's also unmetafied.
+	     * Unmetafied; we need pattern string that's also unmetafied.
 	     * We'll cache it in the patstralloc structure.
 	     * Note it's on the heap.
 	     */
@@ -2389,7 +2389,7 @@ pattryrefs(Patprog prog, char *string, int stringlen, int unmetalenin,
 		/*
 		 * Remember the length in case used for ${..#..} etc.
 		 * In this case, we didn't unmetafy the pattern string
-		 * In the orignal structure, but it might be unmetafied
+		 * in the original structure, but it might be unmetafied
 		 * for use with an unmetafied test string.
 		 */
 		patinlen = pstrlen;
@@ -2619,10 +2619,10 @@ pattryrefs(Patprog prog, char *string, int stringlen, int unmetalenin,
 }
 
 /*
- * Return length of previous succesful match.  This is
+ * Return length of previous successful match.  This is
  * in metafied bytes, i.e. includes a count of Meta characters,
  * unless the match was done on an unmetafied string using
- * a patstralloc stuct, in which case it, too is unmetafed.
+ * a patstralloc struct, in which case it too is unmetafied.
  * Unusual and futile attempt at modular encapsulation.
  */
 
diff --git a/Src/prompt.c b/Src/prompt.c
index 7f4d7a70e..b65bfb86b 100644
--- a/Src/prompt.c
+++ b/Src/prompt.c
@@ -163,7 +163,7 @@ promptpath(char *p, int npath, int tilde)
  *
  * txtchangep gives an integer controlling the attributes of
  * the prompt.  This is for use in zle to maintain the attributes
- * consistenly.  Other parts of the shell should not need to use it.
+ * consistently.  Other parts of the shell should not need to use it.
  */
 
 /**/
diff --git a/Src/subst.c b/Src/subst.c
index b132f251b..f887dbd24 100644
--- a/Src/subst.c
+++ b/Src/subst.c
@@ -91,7 +91,7 @@ keyvalpairelement(LinkList list, LinkNode node)
  * "flag"s contains PREFORK_* flags, defined in zsh.h.
  *
  * "ret_flags" is used to return PREFORK_* values from nested parameter
- * substitions.  It may be NULL in which case PREFORK_SUBEXP must not
+ * substitutions.  It may be NULL in which case PREFORK_SUBEXP must not
  * appear in flags; any return value from below will be discarded.
  */
 
@@ -1548,7 +1548,7 @@ untok_and_escape(char *s, int escapes, int tok_arg)
 /*
  * See if an argument str looks like a subscript or length following
  * a colon and parse it.  It must be followed by a ':' or nothing.
- * If this succeeds, expand and return the evaulated expression if
+ * If this succeeds, expand and return the evaluated expression if
  * found, else return NULL.
  *
  * We assume this is what is meant if the first character is not
@@ -1682,7 +1682,7 @@ paramsubst(LinkList l, LinkNode n, char **str, int qt, int pf_flags,
      */
     int wantt = 0;
     /*
-     * Indicates spliting a string into an array.  There aren't
+     * Indicates splitting a string into an array.  There aren't
      * actually that many special cases for this --- which may
      * be why it doesn't work properly; we split in some cases
      * where we shouldn't, in particular on the multsubs for
@@ -1732,7 +1732,7 @@ paramsubst(LinkList l, LinkNode n, char **str, int qt, int pf_flags,
     int mods = 0;
     /*
      * The (z) flag, nothing to do with SH_WORD_SPLIT which is tied
-     * spbreak, see above; fairly straighforward in use but c.f.
+     * spbreak, see above; fairly straightforward in use but cf.
      * the comment for mods.
      *
      * This gets set to one of the LEXFLAGS_* values.
@@ -2725,7 +2725,7 @@ paramsubst(LinkList l, LinkNode n, char **str, int qt, int pf_flags,
      * substitution is in quotes) always good enough?  Potentially
      * we may be OK by now --- all potential `@'s and subexpressions
      * have been handled, including any [@] index which comes up
-     * by virture of v->isarr being set to SCANPM_ISVAR_AT which
+     * by virtue of v->isarr being set to SCANPM_ISVAR_AT which
      * is now in isarr.
      *
      * However, if we are replacing multsub() with something that
@@ -3110,7 +3110,7 @@ paramsubst(LinkList l, LinkNode n, char **str, int qt, int pf_flags,
 
 	    /*
 	     * Either loop over an array doing replacements or
-	     * do the replacment on a string.
+	     * do the replacement on a string.
 	     *
 	     * We need an untokenized value for matching.
 	     */
diff --git a/Src/text.c b/Src/text.c
index a4191bf1a..69530ae79 100644
--- a/Src/text.c
+++ b/Src/text.c
@@ -584,7 +584,7 @@ gettext2(Estate state)
 		    state->pc = end;
 		    if (!nargs) {
 			/*
-			 * Unnamed fucntion.
+			 * Unnamed function.
 			 * We're not going to pull any arguments off
 			 * later, so skip them now...
 			 */
diff --git a/Src/watch.c b/Src/watch.c
index cd7dc643d..93b3cb134 100644
--- a/Src/watch.c
+++ b/Src/watch.c
@@ -98,7 +98,7 @@
 
 /*
  * In utmpx, the ut_name field is replaced by ut_user.
- * Howver, on some systems ut_name may already be defined this
+ * However, on some systems ut_name may already be defined this
  * way for the purposes of utmp.
  */
 # ifndef ut_name
diff --git a/Src/zsh.h b/Src/zsh.h
index fc3ed2127..9194ea82c 100644
--- a/Src/zsh.h
+++ b/Src/zsh.h
@@ -455,7 +455,7 @@ enum {
  */
 #define FDT_FLOCK_EXEC		6
 /*
- * Entry used by a process substition.
+ * Entry used by a process substitution.
  * This marker is not tested internally as we associated the file
  * descriptor with a job for closing.
  *
@@ -1255,7 +1255,7 @@ enum {
 /*
  * Assignment has value?
  * If the assignment is an arrray, then it certainly has a value --- we
- * can only tell if there's an expicit assignment.
+ * can only tell if there's an explicit assignment.
  */
 
 #define ASG_VALUEP(asg) (ASG_ARRAYP(asg) ||			\
@@ -1444,8 +1444,8 @@ struct builtin {
   */
 #define BINF_HANDLES_OPTS	(1<<18)
 /*
- * Handles the assignement interface.  The argv list actually contains
- * two nested litsts, the first of normal arguments, and the second of
+ * Handles the assignment interface.  The argv list actually contains
+ * two nested lists, the first of normal arguments, and the second of
  * assignment structures.
  */
 #define BINF_ASSIGN		(1<<19)
@@ -2006,7 +2006,7 @@ enum {
 enum {
     /*
      * Set if the string had whitespace at the start
-     * that should cause word splitting against any preceeding string.
+     * that should cause word splitting against any preceding string.
      */
     MULTSUB_WS_AT_START = 1,
     /*
@@ -2272,9 +2272,9 @@ struct histent {
  */
 #define LEXFLAGS_NEWLINE	0x0010
 
-/******************************************/
-/* Definitions for programable completion */
-/******************************************/
+/*******************************************/
+/* Definitions for programmable completion */
+/*******************************************/
 
 /* Nothing special. */
 #define IN_NOTHING 0
diff --git a/Test/A02alias.ztst b/Test/A02alias.ztst
index 99f7aae26..ca415fa39 100644
--- a/Test/A02alias.ztst
+++ b/Test/A02alias.ztst
@@ -129,7 +129,7 @@
   setopt ALIAS_FUNC_DEF
   eval 'goodalias() { print does now work; }'
   isafunc)
-0:ALIAS_FUNC_DEF causes the icky behaviour to be avaliable
+0:ALIAS_FUNC_DEF causes the icky behaviour to be available
 >does now work
 
   (alias thisisokthough='thisworks() { print That worked; }'
diff --git a/Test/C01arith.ztst b/Test/C01arith.ztst
index 9dfc065c8..419f45292 100644
--- a/Test/C01arith.ztst
+++ b/Test/C01arith.ztst
@@ -386,7 +386,7 @@
   esac)
   print after case in subshell)
   '
-0:Non-arithmetic subst with command subsitution parse from hell
+0:Non-arithmetic subst with command substitution parse from hell
 >yes, this one after case in subshell
 
   print "a$((echo one subst)
diff --git a/Test/C02cond.ztst b/Test/C02cond.ztst
index 4ffb07dd4..4b1ec02f0 100644
--- a/Test/C02cond.ztst
+++ b/Test/C02cond.ztst
@@ -388,7 +388,7 @@ F:Failures in these cases do not indicate a problem in the shell.
      eval test $w
      print $?
   done
-0:test compatability weirdness: treat ! as a string sometimes
+0:test compatibility weirdness: treat ! as a string sometimes
 >0
 >0
 >1
diff --git a/Test/D03procsubst.ztst b/Test/D03procsubst.ztst
index 1ef55821b..8cf4e2a7f 100644
--- a/Test/D03procsubst.ztst
+++ b/Test/D03procsubst.ztst
@@ -26,7 +26,7 @@
 >SEcond	ViErtE
 
   diff =(cat FILE1) =(cat FILE2)
-1:=(...) substituion
+1:=(...) substitution
 >1c1
 >< First	Second	Third	Fourth
 >---
diff --git a/Test/D06subscript.ztst b/Test/D06subscript.ztst
index 3ea7fb7e4..c1a8d79cf 100644
--- a/Test/D06subscript.ztst
+++ b/Test/D06subscript.ztst
@@ -190,7 +190,7 @@
 
   typeset -ga empty
   echo X${${empty##*}[-1]}X
-0:Negative index applied to substition result from empty array
+0:Negative index applied to substitution result from empty array
 >XX
 
   print $empty[(i)] $empty[(I)]
@@ -221,7 +221,7 @@
 >fimble two three four
 
   print X$array[(R)notfound]X
-0:(R) yuckily returns the first element on failure withe KSH_ZERO_SUBSCRIPT
+0:(R) yuckily returns the first element on failure with KSH_ZERO_SUBSCRIPT
 >XfimbleX
 
   unsetopt KSH_ZERO_SUBSCRIPT
diff --git a/Test/D08cmdsubst.ztst b/Test/D08cmdsubst.ztst
index 4e0759e35..04bf698aa 100644
--- a/Test/D08cmdsubst.ztst
+++ b/Test/D08cmdsubst.ztst
@@ -174,6 +174,6 @@
     eval '{ OPEN print hi; CLOSE }
     var=$({ OPEN print bye; CLOSE}) && print $var'
   )
-0:Alias expansion needed in parsing substituions
+0:Alias expansion needed in parsing substitutions
 >hi
 >bye
diff --git a/Test/E01options.ztst b/Test/E01options.ztst
index 0f6bb3455..c4b101bdb 100644
--- a/Test/E01options.ztst
+++ b/Test/E01options.ztst
@@ -850,7 +850,7 @@
 
   # With non-special command: original value restored
   # With special builtin: new value kept
-  # With special builtin preceeded by "command": original value restored.
+  # With special builtin preceded by "command": original value restored.
   (setopt posixbuiltins
   FOO=val0
   FOO=val1 true; echo $FOO
diff --git a/Test/V10private.ztst b/Test/V10private.ztst
index 880784e12..a3a63867b 100644
--- a/Test/V10private.ztst
+++ b/Test/V10private.ztst
@@ -104,7 +104,7 @@
   private -h path
   print X$path
  }
-0:privates may hide tied paramters
+0:privates may hide tied parameters
 >X
 
  # Deliberate type mismatch here