Fix typos (#1682)

dwickern · aldenml · web-flow · commit b803b49f9dd9 · 2025-02-10T09:27:35.000+01:00
* fix typos

* use sbt slash syntax in docs

* more documentation typos fix

---------

Co-authored-by: Alden Torres &lt;aldenml@cmaster.us&gt;
diff --git a/.github/workflows/validate-pr.yml b/.github/workflows/validate-pr.yml
@@ -87,7 +87,7 @@ jobs:
           java-version: '${{ matrix.java }}'
           cache: sbt
       - uses: sbt/setup-sbt@v1
-      - name: Scritped test
+      - name: Scripted test
         run: sbt -v '${{ matrix.command }}'
 
   scripted-jdk-packager:
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -42,7 +42,7 @@
 - `sbt docker:publishLocal` sporadically builds with the wrong version [\#1164](https://github.com/sbt/sbt-native-packager/issues/1164)
 - dockerUpdateLatest doesn't update latest [\#1141](https://github.com/sbt/sbt-native-packager/issues/1141)
 - Renaming compiled artifact in package \(feature\) [\#864](https://github.com/sbt/sbt-native-packager/issues/864)
-- Overriden `artifactName` produces image with .jar with wrong content [\#638](https://github.com/sbt/sbt-native-packager/issues/638)
+- Overridden `artifactName` produces image with .jar with wrong content [\#638](https://github.com/sbt/sbt-native-packager/issues/638)
 - Add plugin/support for AWS Elastic Beanstalk Docker environments [\#632](https://github.com/sbt/sbt-native-packager/issues/632)
 
 **Merged pull requests:**
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -37,7 +37,7 @@
 ## Moderation
 
 These are the policies for upholding our community's standards of conduct in our
-communication channels, most notably in sbt-native-packagers’s Github organisation.
+communication channels, most notably in sbt-native-packager’s Github organisation.
 
 1. Remarks that violate the sbt-native-packager code of conduct, including
    hateful, hurtful, oppressive, or exclusionary remarks, are not allowed.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,7 +8,7 @@ packaging types, systemloader and service types. Sometimes this means a pull req
 may take a bit longer, because testing is sometimes hard and tedious. 
 
 Most of the changes are of a very small nature, but can have a huge impact, so try
-to cover the three topis _Code_, _Documentation_ and _Test_ :)
+to cover the three topics _Code_, _Documentation_ and _Test_ :)
 
 ## Code
 
diff --git a/README.md b/README.md
@@ -142,5 +142,5 @@ or provide a richer API for a single packaging format.
 
 ## Credits ##
 
-- [Josh Suereth](https://twitter.com/jsuereth) for the initial developement
+- [Josh Suereth](https://twitter.com/jsuereth) for the initial development
 - [Sascha Rinaldi](http://www.imagelab.net/) for the native-packager logo
diff --git a/src/main/scala/com/typesafe/sbt/packager/FileUtil.scala b/src/main/scala/com/typesafe/sbt/packager/FileUtil.scala
@@ -42,7 +42,7 @@ object chmod {
 }
 
 /**
-  * Converts a octal unix permission representation into a java `PosiFilePermissions` compatible string.
+  * Converts a octal unix permission representation into a java [[PosixFilePermission]] compatible string.
   */
 object permissions {
 
diff --git a/src/main/scala/com/typesafe/sbt/packager/archetypes/TemplateWriter.scala b/src/main/scala/com/typesafe/sbt/packager/archetypes/TemplateWriter.scala
@@ -3,7 +3,7 @@ package com.typesafe.sbt.packager.archetypes
 /**
   * This object provides methods to generate scripts from templates. This involves
   *
-  *   1. procesing - replacing a placeholders with actual values
+  *   1. processing - replacing a placeholders with actual values
   *   1. TODO: validating - check the script if there are no remaining placeholders
   *
   * @example
diff --git a/src/main/scala/com/typesafe/sbt/packager/debian/DebianPlugin.scala b/src/main/scala/com/typesafe/sbt/packager/debian/DebianPlugin.scala
@@ -140,7 +140,7 @@ object DebianPlugin extends AutoPlugin with DebianNativePackaging {
         }
         // override and merge with the user defined scripts. Will change in the future
         val controlScriptsDir = debianControlScriptsDirectory.value
-        val overridenScripts = scripts ++ readContent(
+        val overriddenScripts = scripts ++ readContent(
           Seq(
             scriptMapping(Names.Prerm, debianMakePrermScript.value, controlScriptsDir),
             scriptMapping(Names.Preinst, debianMakePreinstScript.value, controlScriptsDir),
@@ -150,8 +150,8 @@ object DebianPlugin extends AutoPlugin with DebianNativePackaging {
         )
         // --- legacy ends
 
-        // TODO remove the overridenScripts
-        val content = appendedScripts ++ overridenScripts
+        // TODO remove the overriddenScripts
+        val content = appendedScripts ++ overriddenScripts
 
         // apply all replacements
         content.mapValues { lines =>
@@ -320,7 +320,7 @@ object DebianPlugin extends AutoPlugin with DebianNativePackaging {
   *
   * This trait provides a set of helper methods for debian packaging implementations.
   *
-  * Most of the methods are for java 6 file permission handling and debian script adjustements.
+  * Most of the methods are for java 6 file permission handling and debian script adjustments.
   */
 trait DebianPluginLike {
 
diff --git a/src/main/scala/com/typesafe/sbt/packager/debian/Keys.scala b/src/main/scala/com/typesafe/sbt/packager/debian/Keys.scala
@@ -5,7 +5,7 @@ package debian
 import sbt.{*, given}
 import linux.LinuxPackageMapping
 
-/** DEB packaging specifc build targets. */
+/** DEB packaging specific build targets. */
 trait DebianKeys {
   // Metadata keys
   val debianSection = SettingKey[String]("debian-section", "The section category for this deb file.")
diff --git a/src/main/scala/com/typesafe/sbt/packager/docker/DockerSpotifyClientPlugin.scala b/src/main/scala/com/typesafe/sbt/packager/docker/DockerSpotifyClientPlugin.scala
@@ -41,7 +41,7 @@ import sbt._
   * }}}
   *
   * The Docker-spotify client is a provided dependency so you have to add it on your own. It brings a lot of
-  * dependenciesthat could slow your build times. This is the reason the dependency is marked as provided.
+  * dependencies that could slow your build times. This is the reason the dependency is marked as provided.
   */
 object DockerSpotifyClientPlugin extends AutoPlugin {
 
diff --git a/src/main/scala/com/typesafe/sbt/packager/jdkpackager/JDKPackagerAntHelper.scala b/src/main/scala/com/typesafe/sbt/packager/jdkpackager/JDKPackagerAntHelper.scala
@@ -226,7 +226,7 @@ object JDKPackagerAntHelper {
   }
 
   /**
-    * Locate the generated packge.
+    * Locate the generated package.
     *   - TODO: replace with something significantly more intelligent.
     * @param output
     *   output directory
diff --git a/src/main/scala/com/typesafe/sbt/packager/jdkpackager/JDKPackagerKeys.scala b/src/main/scala/com/typesafe/sbt/packager/jdkpackager/JDKPackagerKeys.scala
@@ -7,7 +7,7 @@ import sbt._
 import scala.xml.Node
 
 /**
-  * Keys specific to deployment via the `javapackger` tool.
+  * Keys specific to deployment via the `javapackager` tool.
   *
   * @author
   *   <a href="mailto:fitch@datamininglab.com">Simeon H.K. Fitch</a>
diff --git a/src/main/scala/com/typesafe/sbt/packager/linux/LinuxPackageMapping.scala b/src/main/scala/com/typesafe/sbt/packager/linux/LinuxPackageMapping.scala
@@ -63,7 +63,7 @@ object LinuxSymlink {
   // TODO - Does this belong here?
   def makeSymLinks(symlinks: Seq[LinuxSymlink], pkgDir: File, relativeLinks: Boolean = true): Unit =
     for (link <- symlinks) {
-      // TODO - drop preceeding '/'
+      // TODO - drop preceding '/'
       def dropFirstSlash(n: String): String =
         if (n startsWith "/") n drop 1
         else n
diff --git a/src/main/scala/com/typesafe/sbt/packager/universal/UniversalPlugin.scala b/src/main/scala/com/typesafe/sbt/packager/universal/UniversalPlugin.scala
@@ -64,7 +64,7 @@ object UniversalPlugin extends AutoPlugin {
     // For now, we provide delegates from dist/stage to universal...
     dist := (Universal / dist).value,
     stage := (Universal / stage).value,
-    // TODO - We may need to do this for UniversalSrcs + UnviersalDocs
+    // TODO - We may need to do this for UniversalSrcs + UniversalDocs
     Universal / name := name.value,
     UniversalDocs / name := (Universal / name).value,
     UniversalSrc / name := (Universal / name).value,
diff --git a/src/main/scala/com/typesafe/sbt/packager/validation/package.scala b/src/main/scala/com/typesafe/sbt/packager/validation/package.scala
@@ -5,7 +5,7 @@ import sbt.{*, given}
 /**
   * ==validation==
   *
-  * This package contains stanard validators that can be used by format and archetype plugins.
+  * This package contains standard validators that can be used by format and archetype plugins.
   */
 package object validation {
 
@@ -15,7 +15,7 @@ package object validation {
     * @param mappings
     *   the mappings that should be validated
     * @return
-    *   a validator that checks if the mappins are empty
+    *   a validator that checks if the mappings are empty
     */
   def nonEmptyMappings(mappings: Seq[(File, String)]): Validation.Validator =
     () =>
diff --git a/src/sbt-test/rpm/path-override-rpm/build.sbt b/src/sbt-test/rpm/path-override-rpm/build.sbt
@@ -33,8 +33,8 @@ TaskKey[Unit]("unzip") := {
 
 TaskKey[Unit]("checkInitFile") := {
   val initd = IO.read(baseDirectory.value / "etc" / "init.d" / "rpm-test")
-  assert(initd contains "/opt/test/rpm-test", "defaultLinuxInstallLocation not overriden in init.d\n" + initd)
-  assert(initd contains "/opt/test/log/rpm-test/$logfile", "defaultLinuxLogsLocation not overriden in init.d\n" + initd)
+  assert(initd contains "/opt/test/rpm-test", "defaultLinuxInstallLocation not overridden in init.d\n" + initd)
+  assert(initd contains "/opt/test/log/rpm-test/$logfile", "defaultLinuxLogsLocation not overridden in init.d\n" + initd)
   streams.value.log.success("Successfully tested rpm-test file")
   ()
 }
diff --git a/src/sbt-test/rpm/scriptlets-override-build-rpm/build.sbt b/src/sbt-test/rpm/scriptlets-override-build-rpm/build.sbt
@@ -37,7 +37,7 @@ TaskKey[Unit]("checkSpecFile") := {
   assert(spec contains "%posttrans\necho \"posttrans\"", "Spec doesn't contain %posttrans scriptlet")
   assert(spec contains "%preun\necho \"pre-uninstall\"", "Spec doesn't contain %preun scriptlet")
   assert(spec contains "%postun\necho \"post-uninstall\"", "Spec doesn't contain %postun scriptlet")
-  // Checking for the stuff that should be overriden
+  // Checking for the stuff that should be overridden
   assert(!(spec contains "groupadd --system rpm-test"), "Groupadd should be overridden \n" + spec)
   assert(
     !(spec contains "useradd --gid rpm-test --no-create-home --system -c 'Test rpm package' rpm-test"),
diff --git a/src/sbt-test/universal/publish/test b/src/sbt-test/universal/publish/test
@@ -1,6 +1,6 @@
 # Ensure we can publish to local file system.
 > Universal/publish
-# Ensure isSnpashot works correctly
+# Ensure isSnapshot works correctly
 > Universal/publish
 # Ensure we can publish to local maven repository.
 > Universal/publishM2
diff --git a/src/sphinx/archetypes/jlink_plugin.rst b/src/sphinx/archetypes/jlink_plugin.rst
@@ -60,7 +60,7 @@ This is often caused by depending on automatic modules. In the example above, `c
 
    jlinkModulePath := {
      // Get the full classpath with all the resolved dependencies.
-     fullClasspath.in(jlinkBuildImage).value
+     (jlinkBuildImage / fullClasspath).value
        // Find the ones that have `paranamer` as their names.
        .filter { item =>
          item.get(moduleID.key).exists { modId =>
diff --git a/src/sphinx/formats/debian.rst b/src/sphinx/formats/debian.rst
@@ -158,7 +158,7 @@ Solutions include:
 
 - upgrading to Debian Jessie,
 - upgrading python-apt, note that no official backport is known
-- re-enabling package re-compression in sbt-native-packager, by overridding
+- re-enabling package re-compression in sbt-native-packager, by overriding
   `debianNativeBuildOptions` as described above.
 
 Java based packaging
diff --git a/src/sphinx/formats/docker.rst b/src/sphinx/formats/docker.rst
@@ -157,7 +157,7 @@ Publishing Settings
 ~~~~~~~~~~~~~~~~~~~
 
   ``dockerRepository``
-    The repository to which the image is pushed when the ``Docker / publish`` task is run. This should be of the form  ``[repository.host[:repository.port]]`` (assumes use of the ``index.docker.io`` repository) or ``[repository.host[:repository.port]][/username]`` (discouraged, but available for backwards compatibilty.).
+    The repository to which the image is pushed when the ``Docker / publish`` task is run. This should be of the form  ``[repository.host[:repository.port]]`` (assumes use of the ``index.docker.io`` repository) or ``[repository.host[:repository.port]][/username]`` (discouraged, but available for backwards compatibility.).
 
   ``dockerUsername``
     The username or organization to which the image is pushed when the ``Docker / publish`` task is run. This should be of the form ``[username]`` or ``[organization]``.
@@ -283,7 +283,7 @@ The files from ``Docker / mappings`` are extracted underneath this directory.
 Daemon User
 ~~~~~~~~~~~
 By default, sbt Native Packager will create a daemon user named ``demiourgos728``
-whose UID is set to ``1001``, and and emit ``USER 1001`` since running as non-root is considered the best practice.
+whose UID is set to ``1001``, and emit ``USER 1001`` since running as non-root is considered the best practice.
 
 The following can be used to emit ``USER daemon`` instead:
 
diff --git a/src/sphinx/formats/linux.rst b/src/sphinx/formats/linux.rst
@@ -214,7 +214,7 @@ The basic construct for **adding** a mapping is
     linuxPackageMappings += packageMapping( (theFile, "/absolute/path/somefile.txt") ) withPerms("644") asDocs()
 
 To **filter** or **modify** a mapping, you generally create a new mapping by copying an existing one (or occasionally by creating a new blank one),
-then filter or modify it, and then return that filtered or modified mapping.  Here's an example that shows a number of things you can *possibly* do.  See the next section for specifc examples.
+then filter or modify it, and then return that filtered or modified mapping.  Here's an example that shows a number of things you can *possibly* do.  See the next section for specific examples.
 (Basic scala collections operations are used in the code. `Here is an explanation of the filter method`_.)
 
 .. code-block:: scala
diff --git a/src/sphinx/formats/rpm.rst b/src/sphinx/formats/rpm.rst
@@ -87,7 +87,7 @@ Informational Settings
     Its default value is drawn from the project defined ``version``.
 
   ``rpmRelease``
-    The release number is the package's version. When the sofware is first packaged at a
+    The release number is the package's version. When the software is first packaged at a
     particular version, the release should be ``"1"``. If the software is repackaged at
     the same version, the release number should be incremented, and dropped back to ``"1"``
     when the software version is new.
diff --git a/src/sphinx/formats/universal.rst b/src/sphinx/formats/universal.rst
@@ -233,7 +233,7 @@ so, add the following to your build.sbt:
 
     mapGenericFilesToLinux
 
-    mapGenericFilesToWinows
+    mapGenericFilesToWindows
 
 
 In Linux, this mapping creates symlinks from platform locations to the install location of the universal package.  For example,
@@ -355,7 +355,7 @@ You get a set of methods which will help you to create mappings very easily.
     Universal / mappings ++= directory("src/main/resources/cache")
 
     Universal / mappings ++= contentOf("src/main/resources/docs")
-    
+
     Universal / mappings ++= directory(sourceDirectory.value / "main" / "resources" / "cache")
 
     Universal / mappings ++= contentOf(sourceDirectory.value / "main" / "resources" / "docs")
diff --git a/src/sphinx/formats/windows.rst b/src/sphinx/formats/windows.rst
@@ -125,7 +125,7 @@ Tasks
     Creates the ``msi`` package.
 
   ``wixFile``
-    Generates the Wix xml file from `wixConfig` and `wixProductConfig` setings, unless overriden.
+    Generates the Wix xml file from `wixConfig` and `wixProductConfig` settings, unless overridden.
 
 
 The native-packager plugin provides a few handy utilities for generating Wix XML.  These
diff --git a/src/sphinx/introduction.rst b/src/sphinx/introduction.rst
@@ -47,7 +47,7 @@ deploy target.
 
 These things are **out of native packagers scope**
 
-1. Providing application lifecyle management.
+1. Providing application lifecycle management.
     The :ref:`java-server-plugin` provides *configurations* for common system-loaders like SystemV, Upstart or SystemD.
     However creating a custom solution which includes stop scripts, PID management, etc. are not part of native
     packager.
diff --git a/src/sphinx/recipes/package_configuration.rst b/src/sphinx/recipes/package_configuration.rst
@@ -56,7 +56,7 @@ Now that our application is defined in a module, we can add the three packaging
       )
       .dependsOn(app)
 
-    // bascially identical despite the configuration differences
+    // basically identical despite the configuration differences
     lazy val stagePackage = project
       .in(file("build/stage"))
       .enablePlugins(JavaAppPackaging)
@@ -113,7 +113,7 @@ This pattern may be useful in other scopes as well. First we define an *AutoPlug
 
       object autoImport {
 	object BuildEnv extends Enumeration {
-	  val Production, Stage, Test, Developement = Value
+	  val Production, Stage, Test, Development = Value
 	}
 
 	val buildEnv = settingKey[BuildEnv.Value]("the current build environment")
@@ -128,10 +128,10 @@ This pattern may be useful in other scopes as well. First we define an *AutoPlug
 	       case "prod" => Some(BuildEnv.Production)
 	       case "stage" => Some(BuildEnv.Stage)
 	       case "test" => Some(BuildEnv.Test)
-	       case "dev" => Some(BuildEnv.Developement)
-	       case unkown => None
+	       case "dev" => Some(BuildEnv.Development)
+	       case unknown => None
 	     }
-	     .getOrElse(BuildEnv.Developement)
+	     .getOrElse(BuildEnv.Development)
 	},
 	// give feed back
 	onLoadMessage := {
@@ -163,15 +163,15 @@ plugin as it involves quite some logic. In this case we decide which configurati
 
     Universal / mappings += {
       val confFile = buildEnv.value match {
-	case BuildEnv.Developement => "dev.conf"
+	case BuildEnv.Development => "dev.conf"
 	case BuildEnv.Test => "test.conf"
 	case BuildEnv.Stage => "stage.conf"
 	case BuildEnv.Production => "prod.conf"
       }
       ((Compile / resourceDirectory).value / confFile) -> "conf/application.conf"
     }
 
-Ofcourse you can change all other settings, package names, etc. as well. Building different output packages would look
+Of course you can change all other settings, package names, etc. as well. Building different output packages would look
 like this
 
 .. code-block :: bash
@@ -219,7 +219,7 @@ needs to be done manually. Append this to the ``app`` project.
       // you have to override everything carefully
       packageName := "my-prod-app",
       executableScriptName := "my-prod-app",
-      // this is what we acutally want to change
+      // this is what we actually want to change
       mappings += ((Compile / resourceDirectory).value / "prod.conf") -> "conf/application.conf"
     )))
 
diff --git a/src/sphinx/recipes/umask.rst b/src/sphinx/recipes/umask.rst
@@ -16,7 +16,7 @@ You can set the umask within the generated start script:
    bashScriptExtraDefines += "umask 077"
 
 This line will be added just before the application will be executed by the start script and therefore the application process
-will also inhert this umask. For more information take a look at the :ref:`according documentation<bash-script-defines>`.
+will also inherit this umask. For more information take a look at the :ref:`according documentation<bash-script-defines>`.
 
 .. hint:: When using :ref:`Docker<docker-plugin>` this is the only reliable way `right now <https://github.com/moby/moby/issues/19189>`_ to set the umask for the process. Docker `will ignore <https://stackoverflow.com/a/46900270/810109>`_ any umask set in e.g. `/etc/login.defs` (or other config files) within a docker image.
 

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ object chmod {`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`/**`
`45`		- * Converts a octal unix permission representation into a java `PosiFilePermissions` compatible string.
	`45`	`+ * Converts a octal unix permission representation into a java [[PosixFilePermission]] compatible string.`
`46`	`46`	`*/`
`47`	`47`	`object permissions {`
`48`	`48`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ package com.typesafe.sbt.packager.archetypes`
`3`	`3`	`/**`
`4`	`4`	`* This object provides methods to generate scripts from templates. This involves`
`5`	`5`	`*`
`6`		`- * 1. procesing - replacing a placeholders with actual values`
	`6`	`+ * 1. processing - replacing a placeholders with actual values`
`7`	`7`	`* 1. TODO: validating - check the script if there are no remaining placeholders`
`8`	`8`	`*`
`9`	`9`	`* @example`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ object DebianPlugin extends AutoPlugin with DebianNativePackaging {`
`140`	`140`	`}`
`141`	`141`	`// override and merge with the user defined scripts. Will change in the future`
`142`	`142`	`val controlScriptsDir = debianControlScriptsDirectory.value`
`143`		`- val overridenScripts = scripts ++ readContent(`
	`143`	`+ val overriddenScripts = scripts ++ readContent(`
`144`	`144`	`Seq(`
`145`	`145`	`scriptMapping(Names.Prerm, debianMakePrermScript.value, controlScriptsDir),`
`146`	`146`	`scriptMapping(Names.Preinst, debianMakePreinstScript.value, controlScriptsDir),`
`@@ -150,8 +150,8 @@ object DebianPlugin extends AutoPlugin with DebianNativePackaging {`
`150`	`150`	`)`
`151`	`151`	`// --- legacy ends`
`152`	`152`
`153`		`- // TODO remove the overridenScripts`
`154`		`- val content = appendedScripts ++ overridenScripts`
	`153`	`+ // TODO remove the overriddenScripts`
	`154`	`+ val content = appendedScripts ++ overriddenScripts`
`155`	`155`
`156`	`156`	`// apply all replacements`
`157`	`157`	`content.mapValues { lines =>`
`@@ -320,7 +320,7 @@ object DebianPlugin extends AutoPlugin with DebianNativePackaging {`
`320`	`320`	`*`
`321`	`321`	`* This trait provides a set of helper methods for debian packaging implementations.`
`322`	`322`	`*`
`323`		`- * Most of the methods are for java 6 file permission handling and debian script adjustements.`
	`323`	`+ * Most of the methods are for java 6 file permission handling and debian script adjustments.`
`324`	`324`	`*/`
`325`	`325`	`trait DebianPluginLike {`
`326`	`326`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ import sbt._`
`41`	`41`	`* }}}`
`42`	`42`	`*`
`43`	`43`	`* The Docker-spotify client is a provided dependency so you have to add it on your own. It brings a lot of`
`44`		`- * dependenciesthat could slow your build times. This is the reason the dependency is marked as provided.`
	`44`	`+ * dependencies that could slow your build times. This is the reason the dependency is marked as provided.`
`45`	`45`	`*/`
`46`	`46`	`object DockerSpotifyClientPlugin extends AutoPlugin {`
`47`	`47`