Merge pull request #5855 from jsoref/spelling

Correction of typographical matters (including in code)

Author: mpilgrem

.github/workflows/integration-tests.yml

@@ -118,7 +118,7 @@ jobs:
         path: _release/stack-*
 
   github-release:
-    name: Create Github release
+    name: Create GitHub release
     needs:
     - integration-tests
     - linux-arm64
@@ -157,11 +157,11 @@ jobs:
           shasum -a 256 "$asset" >"$asset.sha256"
           gpg --digest-algo=sha512 --detach-sig --armor -u 0x575159689BEFB442 "$asset"
         done
-    - name: Set Github ref variables
+    - name: Set GitHub ref variables
       id: github_ref_vars
       run: |
         echo ::set-output name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
-    - name: Create Github release (final)
+    - name: Create GitHub release (final)
       if: "!startsWith(github.ref, 'refs/tags/rc/')"
       uses: actions/create-release@v1
       env:
@@ -180,7 +180,7 @@ jobs:
           [INSERT CONTRIBUTORS]
         draft: true
         prerelease: false
-    - name: Create Github release (release candidate)
+    - name: Create GitHub release (release candidate)
       if: "startsWith(github.ref, 'refs/tags/rc/')"
       uses: actions/create-release@v1
       env:
@@ -193,7 +193,7 @@ jobs:
           [INSERT CHANGELOG]
         draft: true
         prerelease: true
-    - name: Upload assets to Github release (final)
+    - name: Upload assets to GitHub release (final)
       if: "!startsWith(github.ref, 'refs/tags/rc/')"
       uses: xresloader/upload-to-github-release@v1
       env:
@@ -204,7 +204,7 @@ jobs:
         draft: true
         prerelease: false
         overwrite: true
-    - name: Upload assets to Github release (release candidate)
+    - name: Upload assets to GitHub release (release candidate)
       if: "startsWith(github.ref, 'refs/tags/rc/')"
       uses: xresloader/upload-to-github-release@v1
       env:

CONTRIBUTING.md

@@ -46,7 +46,7 @@ there is ever a bad change, it can always be rolled back.
 
 Stack's maintainers are long-term contributors to the project. Michael Snoyman
 (@snoyberg) was the founder of Stack, and its initial maintainer - and he has
-added others. Michael's current interests and priorties mean that he is no
+added others. Michael's current interests and priorities mean that he is no
 longer actively involved in adding new features to Stack.
 
 Maintainers are recognized for their contributions including:
@@ -136,7 +136,7 @@ changes/additions based off the
 [stable branch](https://github.com/commercialhaskell/stack/tree/stable).
 
 The specific versions of the online documentation (eg `v: v2.7.5`) are generated
-from the content of files at the point in the responsitory's history specified
+from the content of files at the point in the repository's history specified
 by the corresponding release tag. Consequently, that content is fixed once
 released.
 
@@ -307,7 +307,7 @@ Where `<PATTERN>` is the name of the folder listed in the
 [test/integration/tests/](https://github.com/commercialhaskell/stack/tree/master/test/integration/tests)
 directory.
 
-You may also achieve this through GHCi with tihs command:
+You may also achieve this through GHCi with this command:
 
 ~~~text
 stack ghci stack:stack-integration-test
@@ -341,9 +341,9 @@ This workflow will run if:
 * commits are pushed to these branches: `master`, `stable` and `rc/**`.
 * requested
 
-The workflow has two jobs: `pendantic` and `unit-tests`.
+The workflow has two jobs: `pedantic` and `unit-tests`.
 
-The `pendantic` job runs on `ubuntu` only and builds Stack with the
+The `pedantic` job runs on `ubuntu` only and builds Stack with the
 `--pedantic` flag.
 
 The `unit-tests` job runs on a matrix of operating systems and Stack
@@ -356,7 +356,7 @@ systems. Its 'Cache dependencies on Windows' step caches the same information
 on Windows, but takes into account that a relevant directory is located outside
 of the Stack root.
 
-### Integration-based - `intergration-tests.yml`
+### Integration-based - `integration-tests.yml`
 
 This workflow will run if:
 * there is a pull request
@@ -397,7 +397,7 @@ named artifacts to path `_release`.
 Its step 'Hash and sign assets' makes use of a 'secret' environment variable
 `RELEASE_SIGNING_KEY` established by the owner of the Stack repository. The
 variable contains the private key for the GPG key with ID 0x575159689BEFB442.
-That key is imported into GPG and then used by GPG to create a detached signture
+That key is imported into GPG and then used by GPG to create a detached signature
 for each file.
 
 ### Inactive - `stan.yml`
@@ -408,7 +408,7 @@ workflow does not run. Its intent is to apply Stan to Stack.
 
 ## Slack channel
 
-If you're making deep changes and real-time communcation with the Stack team
+If you're making deep changes and real-time communication with the Stack team
 would be helpful, we have a `#stack-collaborators` Slack channel in the
 Haskell Foundation workspace. To join the workspace, follow this
 [link](https://haskell-foundation.slack.com/join/shared_invite/zt-z45o9x38-8L55P27r12YO0YeEufcO2w#/shared-invite/email).

ChangeLog.md

@@ -175,14 +175,14 @@ Other enhancements:
 * Added `--candidate` flag to `upload` command to upload a package candidate
   rather than publishing the package.
 
-* Error output using `--no-interleaved-output` no longer prepends indentating
+* Error output using `--no-interleaved-output` no longer prepends indenting
   whitespace. This allows emacs compilation-mode and vim quickfix to locate
   and track errors. See
   [#5523](https://github.com/commercialhaskell/stack/pull/5523)
 
 Bug fixes:
 
-* `stack new` now suppports branches other than `master` as default for
+* `stack new` now supports branches other than `master` as default for
   GitHub repositories. See
   [#5422](https://github.com/commercialhaskell/stack/issues/5422)
 
@@ -258,7 +258,7 @@ Bug fixes:
 * Fix the problem of `stack repl foo:test:bar` failing without a project
   build before that. See
   [#5213](https://github.com/commercialhaskell/stack/issues/5213)
-* Fix `stack sdist` introducing unneded sublibrary syntax when using
+* Fix `stack sdist` introducing unnecessary sublibrary syntax when using
   pvp-bounds. See
   [#5289](https://github.com/commercialhaskell/stack/issues/5289)
 
@@ -299,7 +299,7 @@ Release notes:
     * macOS: https://get.haskellstack.org/stable/osx-x86_64.tar.gz
     * Windows 64-bit: https://get.haskellstack.org/stable/windows-x86_64.zip
 
-  As always, binaries for specific versions are available from the Github
+  As always, binaries for specific versions are available from the GitHub
   releases: https://github.com/commercialhaskell/stack/releases.
 
 **Changes since v2.1.3.1**
@@ -581,7 +581,7 @@ Behavior changes:
 * Interleaved output is now turned on by default, see
   [#4702](https://github.com/commercialhaskell/stack/issues/4702). In
   addition, the `packagename> ` prefix is no longer included in
-  interelaved mode when only building a single target.
+  interleaved mode when only building a single target.
 * The `-fhide-source-paths` GHC option is now enabled by default and
   can be disabled via the `hide-source-paths` configuration option in
   `stack.yaml`. See
@@ -862,7 +862,7 @@ Behavior changes:
   optimizations/laziness. See:
   [#4125](https://github.com/commercialhaskell/stack/issues/4125).
 * Mustache templating is not applied to large files (over 50kb) to
-  avoid performance degredation. See:
+  avoid performance degradation. See:
   [#4133](https://github.com/commercialhaskell/stack/issues/4133).
 * `stack upload` signs the package by default, as documented. `--no-signature`
   turns the signing off.
@@ -898,7 +898,7 @@ Other enhancements:
   This should help with
   [#3510](https://github.com/commercialhaskell/stack/issues/3510).
 * `stack new` now allows template names of the form `username/foo` to
-  download from a user other than `commercialstack` on Github, and can be
+  download from a user other than `commercialstack` on GitHub, and can be
   prefixed with the service `github:`, `gitlab:`, or `bitbucket:`. See
   [#4039](https://github.com/commercialhaskell/stack/issues/4039)
 * Switch to `githash` to include some unmerged bugfixes in `gitrev`
@@ -1009,7 +1009,7 @@ Other enhancements:
   that is compatible (rather than only checking a single one).   This is
   relevant on Linux where different distributions may have different
   combinations of libtinfo 5/6, ncurses 5/6, and gmp 4/5, and will allow
-  simpifying the setup-info metadata YAML for future GHC releases.
+  simplifying the setup-info metadata YAML for future GHC releases.
 * The build progress bar reports names of packages currently building.
 * `stack setup --verbose` causes verbose output of GHC configure process.
   See [#3716](https://github.com/commercialhaskell/stack/issues/3716)
@@ -1481,7 +1481,7 @@ Behavior changes:
 
 * The default package metadata backend has been changed from Git to
   the 01-index.tar.gz file, from the hackage-security project. This is
-  intended to address some download speed issues from Github for
+  intended to address some download speed issues from GitHub for
   people in certain geographic regions. There is now full support for
   checking out specific Cabal file revisions from downloaded tarballs
   as well. If you manually specify a package index with only a Git
@@ -1948,7 +1948,7 @@ Other enhancements:
   [#1620](https://github.com/commercialhaskell/stack/issues/1620)
 * `DESTDIR` is filtered from environment when installing GHC. See
   [#1460](https://github.com/commercialhaskell/stack/issues/1460)
-* `stack haddock` now supports `--hadock-arguments`. See
+* `stack haddock` now supports `--haddock-arguments`. See
   [#2144](https://github.com/commercialhaskell/stack/issues/2144)
 * Signing: warn if GPG_TTY is not set as per `man gpg-agent`
 

doc/GUIDE.md

@@ -467,7 +467,7 @@ We've specified the `acme-missiles` package in the `package.yaml` file (see
 above), but `acme-missiles` is not part of that LTS package set, so building
 failed.
 
-To add `acme-missles` to the available packages, we'll use the `extra-deps` key
+To add `acme-missiles` to the available packages, we'll use the `extra-deps` key
 in the `stack.yaml` file. That key defines extra packages, not present in the
 resolver, that will be needed as dependencies. You can add this like so:
 
@@ -496,7 +496,7 @@ You can also see a
 [list of all available snapshots](https://www.stackage.org/snapshots). You'll
 notice two flavors: LTS (for "Long Term Support") and Nightly. You can read more
 about them on the
-[LTS Haskell Github page](https://github.com/commercialhaskell/lts-haskell#readme).
+[LTS Haskell GitHub page](https://github.com/commercialhaskell/lts-haskell#readme).
 If you're not sure which to use, start with LTS Haskell (which Stack will lean
 towards by default as well).
 
@@ -841,7 +841,7 @@ stack build --pedantic --haddock --test --exec "echo Yay, it succeeded" --file-w
 
 This command will:
 
-* turn on all warnings and errors (the `--pendantic` flag)
+* turn on all warnings and errors (the `--pedantic` flag)
 * build your library and executables
 * generate Haddocks (the `--haddock` flag)
 * build and run your test suite (the `--test` flag)
@@ -952,7 +952,7 @@ end up including the helloworld-test component as well.
 
 You can bypass this implicit adding of components by being much more explicit,
 and stating the components directly. For example, the following will not build
-the `helloworld-exe` executable once all executables have been sucessfully
+the `helloworld-exe` executable once all executables have been successfully
 built:
 
 ~~~text
@@ -1307,7 +1307,7 @@ follows the Unix convention of `--` to separate these. For example, command:
 stack exec --package stm -- echo I installed the stm package via --package stm
 ~~~
 
-yields ouput like:
+yields output like:
 
 ~~~text
 Run from outside a project, using implicit global project config

doc/GUIDE_advanced.md

@@ -78,7 +78,7 @@ the command, see the [build command](build_command.md) documentation.
 
 ## The `stack config` commands
 
-The `stack config` commands provide assistence with accessing or modifying
+The `stack config` commands provide assistance with accessing or modifying
 Stack's configuration. See `stack config` for the available commands.
 
 ## The `stack config env` command
@@ -290,7 +290,7 @@ All done.
 
 The default templates repository is
 https://github.com/commercialhaskell/stack-templates. You can download templates
-from a different Github user by prefixing the username and a slash. Command:
+from a different GitHub user by prefixing the username and a slash. Command:
 
 ~~~text
 stack new my-yesod-project yesodweb/simple
@@ -442,7 +442,7 @@ For further information, see the [Azure CI](azure_ci.md) documentation.
 
 ### Travis
 
-For futher information, see the [Travis CI](travis_ci.md) documentation.
+For further information, see the [Travis CI](travis_ci.md) documentation.
 
 ## Editor integration
 

doc/README.md

@@ -101,7 +101,7 @@ stack exec my-project-exe
 - The `stack build` command will build the template project and create an
   executable named `my-project-exe` (on Windows, `my-project-exe.exe`). First,
   if necessary, Stack will download a version of GHC in an isolated location.
-  That won't interfere with other GHC instalations on your system.
+  That won't interfere with other GHC installations on your system.
 - The `stack exec my-project-exe` command will run (execute) the built
   executable, in Stack's environment.
 
@@ -264,7 +264,7 @@ The following assumes that you already have installed a version of Stack and the
     cd stack
     ~~~
 
-3.  Build the `stack` executable using a pre-existing installation of Stack with
+3.  Build the `stack` executable using a preexisting installation of Stack with
     the command:
 
     ~~~text
@@ -280,7 +280,7 @@ The following assumes that you already have installed a version of Stack and the
 
     Make sure the version is the latest one.
 
-5.  In the GitHub respository's issue tracker, look for issues tagged with
+5.  In the GitHub repository's issue tracker, look for issues tagged with
     [newcomer friendly](https://github.com/commercialhaskell/stack/issues?q=is%3Aopen+is%3Aissue+label%3a%22newcomer+friendly%22)
     and
     [awaiting pull request](https://github.com/commercialhaskell/stack/issues?q=is%3Aopen+is%3Aissue+label%3A%22awaiting+pull+request%22)

doc/Stack_and_VS_Code.md

@@ -87,7 +87,7 @@ necessary (they are not, if only Stack is being used).
 
 For this workaround to work, however, there can be no differences between the
 version of GHC that the GHCup-supplied HLS was built with and the version that
-Stack has installed. A slight inconvenience here is also the posibility of false
+Stack has installed. A slight inconvenience here is also the possibility of false
 messages from the start-up that need to be ignored. In principle, those messages
 can be disabled by
 [setting the following](https://github.com/haskell/vscode-haskell#setting-a-specific-toolchain)

doc/azure/azure-pipelines.yml

@@ -5,10 +5,10 @@
 #
 # https://docs.haskellstack.org/en/stable/azure_ci/
 #
-# Copy these contents into the root directory of your Github project in a file
+# Copy these contents into the root directory of your GitHub project in a file
 # named azure-pipelines.yml
 #
-# For better organization, you split various jobs into seprate parts
+# For better organization, you split various jobs into separate parts
 # and each of them are controlled via individual file.
 jobs:
 - template: azure-linux-template.yml

doc/azure/azure-simple.yml

@@ -5,7 +5,7 @@
 #
 # https://docs.haskellstack.org/en/stable/azure_ci/
 #
-# Copy these contents into the root directory of your Github project in a file
+# Copy these contents into the root directory of your GitHub project in a file
 # named azure-pipelines.yml
 
 # Choose a agent virtual image

doc/coverage.md

@@ -36,7 +36,7 @@ When your project has these properties, you will get the following:
 2.  A unified textual and HTML report, considering the coverage on all local
     libraries, based on all of the tests that were run.
 
-3.  An index of all generated HTML reports, in `index.html` in the the local
+3.  An index of all generated HTML reports, in `index.html` in the local
     HPC root directory.
 
 ## The `stack hpc report` command