Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run codespell on source #23367

Merged
merged 1 commit into from
Jul 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ test/version/version: version/version.go

.PHONY: codespell
codespell:
codespell -S bin,vendor,.git,go.sum,.cirrus.yml,"*.fish,RELEASE_NOTES.md,*.xz,*.gz,*.ps1,*.tar,swagger.yaml,*.tgz,bin2img,*ico,*.png,*.1,*.5,copyimg,*.orig,apidoc.go" -L secon,passt,bu,hastable,te,clos,ans,pullrequest,uint,iff,od,seeked,splitted,marge,erro,hist,ether,specif -w
codespell -S bin,vendor,.git,go.sum,.cirrus.yml,"*.fish,RELEASE_NOTES.md,*.xz,*.gz,*.ps1,*.tar,swagger.yaml,*.tgz,bin2img,*ico,*.png,*.1,*.5,copyimg,*.orig,apidoc.go" -L ddress,secon,passt,bu,hastable,te,clos,ans,pullrequest,uint,iff,od,seeked,splitted,marge,erro,hist,ether,specif -w
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to add magic comments, like for linters, immediately adjacent to the offending word? ISTM that we want to allow exactly one instance of ddress, but maybe not new ones?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No idea, although I don't think this is a common spelling mistake.


# Code validation target that **DOES NOT** require building podman binaries
.PHONY: validate-source
Expand Down
2 changes: 1 addition & 1 deletion build_windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The installer includes a C program that checks the installation of the
pre-required virtualization providers (WSL or Hyper-V). Building this program
requires the
[Microsoft C/C++ compiler](https://learn.microsoft.com/en-us/cpp/build/building-on-the-command-line?view=msvc-170) and the
[PowerShell Moduel VSSetup](https://github.com/microsoft/vssetup.powershell):
[PowerShell Module VSSetup](https://github.com/microsoft/vssetup.powershell):

1. Download the Build Tools for Visual Studio 2022 installer
```pwsh
Expand Down
2 changes: 1 addition & 1 deletion contrib/cirrus/setup_environment.sh
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ case "$TEST_FLAVOR" in
showrun make .install.ginkgo
;&
sys)
# when run nighlty check for system test leaks
# when run nightly check for system test leaks
# shellcheck disable=SC2154
if [[ "$CIRRUS_CRON" != '' ]]; then
export PODMAN_BATS_LEAK_CHECK=1
Expand Down
4 changes: 2 additions & 2 deletions docs/source/markdown/podman-systemd.unit.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -1422,7 +1422,7 @@ Valid options for `[Build]` are listed below:
Add an image *annotation* (e.g. annotation=*value*) to the image metadata. Can be used multiple
times.

This is equivalant to the `--annotation` option of `podman build`.
This is equivalent to the `--annotation` option of `podman build`.

### `Arch=`

Expand Down Expand Up @@ -1631,7 +1631,7 @@ particularly interesting when using special options to control image pulls.
Note: The generated service have a dependency on `network-online.target` assuring the network is reachable if
an image needs to be pulled.
If the image service needs to run without available network (e.g. early in boot), the requirement can be
overriden simply by adding an empty `After=` in the unit file. This will unset all previously set After's.
overridden simply by adding an empty `After=` in the unit file. This will unset all previously set After's.

Valid options for `[Image]` are listed below:

Expand Down
2 changes: 1 addition & 1 deletion libpod/container_api.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ func (c *Container) Start(ctx context.Context, recursive bool) (finalErr error)

// Update updates the given container.
// Either resource limits or restart policy can be updated.
// Either resourcs or restartPolicy must not be nil.
// Either resources or restartPolicy must not be nil.
// If restartRetries is not nil, restartPolicy must be set and must be "on-failure".
func (c *Container) Update(resources *spec.LinuxResources, restartPolicy *string, restartRetries *uint) error {
if !c.batched {
Expand Down
2 changes: 1 addition & 1 deletion pkg/api/handlers/compat/images_build.go
Original file line number Diff line number Diff line change
Expand Up @@ -740,7 +740,7 @@ func BuildImage(w http.ResponseWriter, r *http.Request) {

platforms := query.Platform
if len(platforms) == 1 {
// Docker API uses comma sperated platform arg so match this here
// Docker API uses comma separated platform arg so match this here
platforms = strings.Split(query.Platform[0], ",")
}
for _, platformSpec := range platforms {
Expand Down
4 changes: 2 additions & 2 deletions pkg/machine/apple/apple.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ func GenerateSystemDFilesForVirtiofsMounts(mounts []machine.VirtIoFs) ([]ignitio
return unitFiles, nil
}

// StartGenericAppleVM is wrappered by apple provider methods and starts the vm
// StartGenericAppleVM is wrapped by apple provider methods and starts the vm
func StartGenericAppleVM(mc *vmconfigs.MachineConfig, cmdBinary string, bootloader vfConfig.Bootloader, endpoint string) (func() error, func() error, error) {
var (
ignitionSocket *define.VMFile
Expand Down Expand Up @@ -366,7 +366,7 @@ func CheckProcessRunning(processName string, pid int) error {
return nil
}

// StartGenericNetworking is wrappered by apple provider methods
// StartGenericNetworking is wrapped by apple provider methods
func StartGenericNetworking(mc *vmconfigs.MachineConfig, cmd *gvproxy.GvproxyCommand) error {
gvProxySock, err := mc.GVProxySocket()
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion pkg/machine/ocipull/ociartifact.go
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ func (o *OCIArtifactDisk) get() (func(), error) {

func (o *OCIArtifactDisk) cleanCache(cachedImagePath string) func() {
// cache miss while using an image that we cache, ie the default image
// clean out all old files fron the cache dir
// clean out all old files from the cache dir
if o.cache {
files, err := os.ReadDir(o.dirs.ImageCacheDir.GetPath())
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion test/system/160-volumes.bats
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ EOF
hostfs=$(stat -f -c %T $output)

# stat -f -c %T seems to just return unknown for our normal bind mount for some reason.
# Therfore manually parse /proc/mounts to get the real fs for the bind mount.
# Therefore manually parse /proc/mounts to get the real fs for the bind mount.
CONTAINERS_CONF_OVERRIDE="$containersconf" run_podman run --image-volume anonymous --rm volume_image \
sh -c "grep ' /data ' /proc/mounts | cut -f3 -d' '"
assert "$output" == "$hostfs" "Should match hosts graphroot fs"
Expand Down