Fixes from make codespell

rhatdan · rhatdan · commit 9c8277247d3e · 2021-04-21T13:16:33.000-04:00
Signed-off-by: Daniel J Walsh &lt;dwalsh@redhat.com&gt;
diff --git a/Makefile b/Makefile
@@ -149,7 +149,7 @@ err_if_empty = $(if $(strip $($(1))),$(strip $($(1))),$(error Required variable
 
 # Podman does not work w/o CGO_ENABLED, except in some very specific cases
 CGO_ENABLED ?= 1
-# Default to the native OS type and archetecture unless otherwise specified
+# Default to the native OS type and architecture unless otherwise specified
 GOOS ?= $(shell $(GO) env GOOS)
 ifeq ($(call err_if_empty,GOOS),windows)
 BINSFX := .exe
@@ -255,7 +255,7 @@ test/goecho/goecho: .gopathok $(wildcard test/goecho/*.go)
 
 .PHONY: codespell
 codespell:
-	codespell -S bin,vendor,.git,go.sum,changelog.txt,.cirrus.yml,"RELEASE_NOTES.md,*.xz,*.gz,*.tar,*.tgz,bin2img,*ico,*.png,*.1,*.5,copyimg,*.orig,apidoc.go" -L uint,iff,od,seeked,splitted,marge,ERRO,hist -w
+	codespell -S bin,vendor,.git,go.sum,changelog.txt,.cirrus.yml,"RELEASE_NOTES.md,*.xz,*.gz,*.tar,*.tgz,bin2img,*ico,*.png,*.1,*.5,copyimg,*.orig,apidoc.go" -L uint,iff,od,seeked,splitted,marge,ERRO,hist,ether -w
 
 .PHONY: validate
 validate: gofmt lint .gitvalidation validate.completions man-page-check swagger-check tests-included
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md
@@ -196,7 +196,7 @@ spelled with complete minutiae.
    1. Merge the PR (or ask someone else to review and merge, to be safer).
    1. **Note:** This is the last point where any test-failures can be addressed
       by code changes. After pushing the new version-tag upstream, no further
-      changes can be made to the code without lots of unpleasent efforts.  Please
+      changes can be made to the code without lots of unpleasant efforts.  Please
       seek assistance if needed, before proceeding.
 
    1. Assuming the "Bump to ..." PR merged successfully, and you're **really**
diff --git a/cmd/podman/machine/stop.go b/cmd/podman/machine/stop.go
@@ -30,7 +30,7 @@ func init() {
 	})
 }
 
-// TODO  Name shouldnt be required, need to create a default vm
+// TODO  Name shouldn't be required, need to create a default vm
 func stop(cmd *cobra.Command, args []string) error {
 	var (
 		err    error
diff --git a/completions/powershell/podman-remote.ps1 b/completions/powershell/podman-remote.ps1
@@ -161,7 +161,7 @@ Register-ArgumentCompleter -CommandName 'podman-remote' -ScriptBlock {
 
     $Values | ForEach-Object {
 
-        # store temporay because switch will overwrite $_
+        # store temporary because switch will overwrite $_
         $comp = $_
 
         # PowerShell supports three different completion modes
@@ -216,7 +216,7 @@ Register-ArgumentCompleter -CommandName 'podman-remote' -ScriptBlock {
             Default {
                 # Like MenuComplete but we don't want to add a space here because
                 # the user need to press space anyway to get the completion.
-                # Description will not be shown because thats not possible with TabCompleteNext
+                # Description will not be shown because that's not possible with TabCompleteNext
                 [System.Management.Automation.CompletionResult]::new($($comp.Name | __podman-remote_escapeStringWithSpecialChars), "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
             }
         }
diff --git a/completions/powershell/podman.ps1 b/completions/powershell/podman.ps1
@@ -161,7 +161,7 @@ Register-ArgumentCompleter -CommandName 'podman' -ScriptBlock {
 
     $Values | ForEach-Object {
 
-        # store temporay because switch will overwrite $_
+        # store temporary because switch will overwrite $_
         $comp = $_
 
         # PowerShell supports three different completion modes
@@ -216,7 +216,7 @@ Register-ArgumentCompleter -CommandName 'podman' -ScriptBlock {
             Default {
                 # Like MenuComplete but we don't want to add a space here because
                 # the user need to press space anyway to get the completion.
-                # Description will not be shown because thats not possible with TabCompleteNext
+                # Description will not be shown because that's not possible with TabCompleteNext
                 [System.Management.Automation.CompletionResult]::new($($comp.Name | __podman_escapeStringWithSpecialChars), "$($comp.Name)", 'ParameterValue', "$($comp.Description)")
             }
         }
diff --git a/contrib/cirrus/runner.sh b/contrib/cirrus/runner.sh
@@ -277,7 +277,7 @@ logformatter() {
             |& awk --file "${CIRRUS_WORKING_DIR}/${SCRIPT_BASE}/timestamp.awk" \
             |& "${CIRRUS_WORKING_DIR}/${SCRIPT_BASE}/logformatter" "$output_name"
     else
-        # Assume script is run by a human, they want output immediatly
+        # Assume script is run by a human, they want output immediately
         cat -
     fi
 }
diff --git a/docs/remote-docs.sh b/docs/remote-docs.sh
@@ -6,7 +6,7 @@ PLATFORM=$1                         ## linux, windows or darwin
 TARGET=${2}                         ## where to output files
 SOURCES=${@:3}                      ## directories to find markdown files
 
-# Overriden for testing.  Native podman-remote binary expected filepaths
+# Overridden for testing.  Native podman-remote binary expected filepaths
 if [[ -z "$PODMAN" ]]; then
     case $(env -i HOME=$HOME PATH=$PATH go env GOOS) in
         windows)
diff --git a/docs/source/markdown/podman-secret-create.1.md b/docs/source/markdown/podman-secret-create.1.md
@@ -16,7 +16,7 @@ A secret is a blob of sensitive data which a container needs at runtime but
 should not be stored in the image or in source control, such as usernames and passwords,
 TLS certificates and keys, SSH keys or other important generic strings or binary content (up to 500 kb in size).
 
-Secrets will not be commited to an image with `podman commit`, and will not be in the archive created by a `podman export`
+Secrets will not be committed to an image with `podman commit`, and will not be in the archive created by a `podman export`
 
 ## OPTIONS
 
diff --git a/libpod/container_internal.go b/libpod/container_internal.go
@@ -1313,7 +1313,7 @@ func (c *Container) stop(timeout uint) error {
 	}
 
 	// We have to check stopErr *after* we lock again - otherwise, we have a
-	// change of panicing on a double-unlock. Ref: GH Issue 9615
+	// change of panicking on a double-unlock. Ref: GH Issue 9615
 	if stopErr != nil {
 		return stopErr
 	}
@@ -1676,7 +1676,7 @@ func (c *Container) chownVolume(volumeName string) error {
 
 	// TODO: For now, I've disabled chowning volumes owned by non-Podman
 	// drivers. This may be safe, but it's really going to be a case-by-case
-	// thing, I think - safest to leave disabled now and reenable later if
+	// thing, I think - safest to leave disabled now and re-enable later if
 	// there is a demand.
 	if vol.state.NeedsChown && !vol.UsesVolumeDriver() {
 		vol.state.NeedsChown = false
diff --git a/libpod/define/fileinfo.go b/libpod/define/fileinfo.go
@@ -5,7 +5,7 @@ import (
 	"time"
 )
 
-// FileInfo describes the attributes of a file or diretory.
+// FileInfo describes the attributes of a file or directory.
 type FileInfo struct {
 	Name       string      `json:"name"`
 	Size       int64       `json:"size"`
diff --git a/libpod/image/utils.go b/libpod/image/utils.go
@@ -50,7 +50,7 @@ func findImageInRepotags(search imageParts, images []*Image) (*storage.Image, er
 
 	// If more then one candidate and the candidates all have same name
 	// and only one is read/write return it.
-	// Othewise return error with the list of candidates
+	// Otherwise return error with the list of candidates
 	if len(candidates) > 1 {
 		var (
 			rwImage    *Image
diff --git a/libpod/shutdown/handler.go b/libpod/shutdown/handler.go
@@ -18,7 +18,7 @@ var (
 	stopped    bool
 	sigChan    chan os.Signal
 	cancelChan chan bool
-	// Syncronize accesses to the map
+	// Synchronize accesses to the map
 	handlerLock sync.Mutex
 	// Definitions of all on-shutdown handlers
 	handlers map[string]func(os.Signal) error
diff --git a/pkg/api/handlers/utils/containers.go b/pkg/api/handlers/utils/containers.go
@@ -76,7 +76,7 @@ func WaitContainerDocker(w http.ResponseWriter, r *http.Request) {
 	exitCode, err := waitDockerCondition(ctx, name, interval, condition)
 	msg := ""
 	if err != nil {
-		logrus.Errorf("error while waiting on condtion: %q", err)
+		logrus.Errorf("error while waiting on condition: %q", err)
 		msg = err.Error()
 	}
 	responseData := handlers.ContainerWaitOKBody{
diff --git a/pkg/domain/infra/abi/play.go b/pkg/domain/infra/abi/play.go
@@ -428,7 +428,7 @@ func readConfigMapFromFile(r io.Reader) (v1.ConfigMap, error) {
 	return cm, nil
 }
 
-// splitMultiDocYAML reads mutiple documents in a YAML file and
+// splitMultiDocYAML reads multiple documents in a YAML file and
 // returns them as a list.
 func splitMultiDocYAML(yamlContent []byte) ([][]byte, error) {
 	var documentList [][]byte
@@ -471,7 +471,7 @@ func getKubeKind(obj []byte) (string, error) {
 }
 
 // sortKubeKinds adds the correct creation order for the kube kinds.
-// Any pod dependecy will be created first like volumes, secrets, etc.
+// Any pod dependency will be created first like volumes, secrets, etc.
 func sortKubeKinds(documentList [][]byte) ([][]byte, error) {
 	var sortedDocumentList [][]byte
 
diff --git a/pkg/machine/pull.go b/pkg/machine/pull.go
@@ -170,7 +170,7 @@ func Decompress(localPath, uncompressedPath string) error {
 
 // Will error out if file without .xz already exists
 // Maybe extracting then renameing is a good idea here..
-// depends on xz: not pre-installed on mac, so it becomes a brew dependecy
+// depends on xz: not pre-installed on mac, so it becomes a brew dependency
 func decompressXZ(src string, output io.Writer) error {
 	fmt.Println("Extracting compressed file")
 	cmd := exec.Command("xzcat", "-k", src)
diff --git a/pkg/specgen/generate/kube/kube.go b/pkg/specgen/generate/kube/kube.go
@@ -56,7 +56,7 @@ func ToPodGen(ctx context.Context, podName string, podYAML *v1.PodTemplateSpec)
 			}
 			p.DNSServer = servers
 		}
-		// search domans
+		// search domains
 		if domains := dnsConfig.Searches; len(domains) > 0 {
 			p.DNSSearch = domains
 		}
diff --git a/pkg/systemd/generate/common_test.go b/pkg/systemd/generate/common_test.go
@@ -199,8 +199,8 @@ func TestEscapeSystemdArguments(t *testing.T) {
 			[]string{"foo", `"command with backslash \\"`},
 		},
 		{
-			[]string{"foo", `command with two backslashs \\`},
-			[]string{"foo", `"command with two backslashs \\\\"`},
+			[]string{"foo", `command with two backslashes \\`},
+			[]string{"foo", `"command with two backslashes \\\\"`},
 		},
 	}
 
diff --git a/pkg/util/filters.go b/pkg/util/filters.go
@@ -94,7 +94,7 @@ func PrepareFilters(r *http.Request) (*map[string][]string, error) {
 	return &filterMap, nil
 }
 
-// MatchLabelFilters matches labels and returs true if they are valid
+// MatchLabelFilters matches labels and returns true if they are valid
 func MatchLabelFilters(filterValues []string, labels map[string]string) bool {
 outer:
 	for _, filterValue := range filterValues {
diff --git a/test/apiv2/rest_api/test_rest_v2_0_0.py b/test/apiv2/rest_api/test_rest_v2_0_0.py
@@ -378,7 +378,7 @@ def do_search3():
             self.assertEqual(r.status_code, 200, r.text)
             objs = json.loads(r.text)
             self.assertIn(type(objs), (list,))
-            # There should be only one offical image
+            # There should be only one official image
             self.assertEqual(len(objs), 1)
 
         def do_search4():
diff --git a/test/system/050-stop.bats b/test/system/050-stop.bats
@@ -114,7 +114,7 @@ load helpers
 @test "podman stop - unlock while waiting for timeout" {
     # Test that the container state transitions to "stopping" and that other
     # commands can get the container's lock.  To do that, run a container that
-    # ingores SIGTERM such that the Podman would wait 20 seconds for the stop
+    # ignores SIGTERM such that the Podman would wait 20 seconds for the stop
     # to finish.  This gives us enough time to try some commands and inspect
     # the container's status.
 
diff --git a/test/system/070-build.bats b/test/system/070-build.bats
@@ -354,7 +354,7 @@ Cmd[1]             | $s_echo
 WorkingDir         | $workdir
 Labels.$label_name | $label_value
 "
-    # FIXME: 2021-02-24: Fixed in buildah #3036; reenable this once podman
+    # FIXME: 2021-02-24: Fixed in buildah #3036; re-enable this once podman
     #        vendors in a newer buildah!
     # Labels.\"io.buildah.version\" | $buildah_version
 

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ func init() {`
`30`	`30`	`})`
`31`	`31`	`}`
`32`	`32`
`33`		`-// TODO Name shouldnt be required, need to create a default vm`
	`33`	`+// TODO Name shouldn't be required, need to create a default vm`
`34`	`34`	`func stop(cmd *cobra.Command, args []string) error {`
`35`	`35`	`var (`
`36`	`36`	`err error`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ Register-ArgumentCompleter -CommandName 'podman-remote' -ScriptBlock {`
`161`	`161`
`162`	`162`	`$Values \| ForEach-Object {`
`163`	`163`
`164`		`- # store temporay because switch will overwrite $_`
	`164`	`+ # store temporary because switch will overwrite $_`
`165`	`165`	`$comp = $_`
`166`	`166`
`167`	`167`	`# PowerShell supports three different completion modes`
`@@ -216,7 +216,7 @@ Register-ArgumentCompleter -CommandName 'podman-remote' -ScriptBlock {`
`216`	`216`	`Default {`
`217`	`217`	`# Like MenuComplete but we don't want to add a space here because`
`218`	`218`	`# the user need to press space anyway to get the completion.`
`219`		`- # Description will not be shown because thats not possible with TabCompleteNext`
	`219`	`+ # Description will not be shown because that's not possible with TabCompleteNext`
`220`	`220`	`[System.Management.Automation.CompletionResult]::new($($comp.Name \| __podman-remote_escapeStringWithSpecialChars), "$($comp.Name)", 'ParameterValue', "$($comp.Description)")`
`221`	`221`	`}`
`222`	`222`	`}`
Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ logformatter() {`
`277`	`277`	`\|& awk --file "${CIRRUS_WORKING_DIR}/${SCRIPT_BASE}/timestamp.awk" \`
`278`	`278`	`\|& "${CIRRUS_WORKING_DIR}/${SCRIPT_BASE}/logformatter" "$output_name"`
`279`	`279`	`else`
`280`		`- # Assume script is run by a human, they want output immediatly`
	`280`	`+ # Assume script is run by a human, they want output immediately`
`281`	`281`	`cat -`
`282`	`282`	`fi`
`283`	`283`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`"time"`
`6`	`6`	`)`
`7`	`7`
`8`		`-// FileInfo describes the attributes of a file or diretory.`
	`8`	`+// FileInfo describes the attributes of a file or directory.`
`9`	`9`	`type FileInfo struct {`
`10`	`10`	Name string `json:"name"`
`11`	`11`	Size int64 `json:"size"`