Skip to content

Commit cbc7872

Browse files
committed
🐛 fix typos in scaffolded makefiles
1 parent 68abac1 commit cbc7872

File tree

15 files changed

+92
-92
lines changed

15 files changed

+92
-92
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ endif
3030

3131
# The help target prints out all targets with their descriptions organized
3232
# beneath their categories. The categories are represented by '##@' and the
33-
# target descriptions by '##'. The awk commands is responsible for reading the
33+
# target descriptions by '##'. The awk command is responsible for reading the
3434
# entire set of makefiles included in this invocation, looking for lines of the
3535
# file as xyz: ## something, and then pretty-format the target and help. Then,
3636
# if there's a line with ##@ something, that gets pretty-printed as a category.

docs/book/src/component-config-tutorial/testdata/project/Makefile

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ all: build
2929

3030
# The help target prints out all targets with their descriptions organized
3131
# beneath their categories. The categories are represented by '##@' and the
32-
# target descriptions by '##'. The awk commands is responsible for reading the
32+
# target descriptions by '##'. The awk command is responsible for reading the
3333
# entire set of makefiles included in this invocation, looking for lines of the
3434
# file as xyz: ## something, and then pretty-format the target and help. Then,
3535
# if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -74,8 +74,8 @@ build: manifests generate fmt vet ## Build manager binary.
7474
run: manifests generate fmt vet ## Run a controller from your host.
7575
go run ./cmd/main.go
7676

77-
# If you wish built the manager image targeting other platforms you can use the --platform flag.
78-
# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
77+
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
78+
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
7979
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
8080
.PHONY: docker-build
8181
docker-build: test ## Build docker image with the manager.
@@ -85,12 +85,12 @@ docker-build: test ## Build docker image with the manager.
8585
docker-push: ## Push docker image with the manager.
8686
$(CONTAINER_TOOL) push ${IMG}
8787

88-
# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
88+
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
8989
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
90-
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
91-
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
92-
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
93-
# To properly provided solutions that supports more than one platform you should use this option.
90+
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
91+
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
92+
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
93+
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
9494
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
9595
.PHONY: docker-buildx
9696
docker-buildx: test ## Build and push docker image for the manager for cross-platform support

docs/book/src/cronjob-tutorial/testdata/project/Makefile

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ all: build
2929

3030
# The help target prints out all targets with their descriptions organized
3131
# beneath their categories. The categories are represented by '##@' and the
32-
# target descriptions by '##'. The awk commands is responsible for reading the
32+
# target descriptions by '##'. The awk command is responsible for reading the
3333
# entire set of makefiles included in this invocation, looking for lines of the
3434
# file as xyz: ## something, and then pretty-format the target and help. Then,
3535
# if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -74,8 +74,8 @@ build: manifests generate fmt vet ## Build manager binary.
7474
run: manifests generate fmt vet ## Run a controller from your host.
7575
go run ./cmd/main.go
7676

77-
# If you wish built the manager image targeting other platforms you can use the --platform flag.
78-
# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
77+
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
78+
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
7979
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
8080
.PHONY: docker-build
8181
docker-build: test ## Build docker image with the manager.
@@ -85,12 +85,12 @@ docker-build: test ## Build docker image with the manager.
8585
docker-push: ## Push docker image with the manager.
8686
$(CONTAINER_TOOL) push ${IMG}
8787

88-
# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
88+
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
8989
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
90-
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
91-
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
92-
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
93-
# To properly provided solutions that supports more than one platform you should use this option.
90+
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
91+
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
92+
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
93+
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
9494
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
9595
.PHONY: docker-buildx
9696
docker-buildx: test ## Build and push docker image for the manager for cross-platform support

docs/book/src/multiversion-tutorial/testdata/project/Makefile

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ all: build
2323

2424
# The help target prints out all targets with their descriptions organized
2525
# beneath their categories. The categories are represented by '##@' and the
26-
# target descriptions by '##'. The awk commands is responsible for reading the
26+
# target descriptions by '##'. The awk command is responsible for reading the
2727
# entire set of makefiles included in this invocation, looking for lines of the
2828
# file as xyz: ## something, and then pretty-format the target and help. Then,
2929
# if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -72,8 +72,8 @@ build: manifests generate fmt vet ## Build manager binary.
7272
run: manifests generate fmt vet ## Run a controller from your host.
7373
go run ./cmd/main.go
7474

75-
# If you wish built the manager image targeting other platforms you can use the --platform flag.
76-
# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
75+
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
76+
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
7777
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
7878
.PHONY: docker-build
7979
docker-build: test ## Build docker image with the manager.
@@ -83,12 +83,12 @@ docker-build: test ## Build docker image with the manager.
8383
docker-push: ## Push docker image with the manager.
8484
docker push ${IMG}
8585

86-
# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
86+
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
8787
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
88-
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
89-
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
90-
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
91-
# To properly provided solutions that supports more than one platform you should use this option.
88+
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
89+
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
90+
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
91+
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
9292
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
9393
.PHONY: docker-buildx
9494
docker-buildx: test ## Build and push docker image for the manager for cross-platform support

docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ all: build
2020

2121
# The help target prints out all targets with their descriptions organized
2222
# beneath their categories. The categories are represented by '##@' and the
23-
# target descriptions by '##'. The awk commands is responsible for reading the
23+
# target descriptions by '##'. The awk command is responsible for reading the
2424
# entire set of makefiles included in this invocation, looking for lines of the
2525
# file as xyz: ## something, and then pretty-format the target and help. Then,
2626
# if there's a line with ##@ something, that gets pretty-printed as a category.

pkg/plugins/golang/v2/scaffolds/internal/templates/makefile.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ all: build
7474
7575
# The help target prints out all targets with their descriptions organized
7676
# beneath their categories. The categories are represented by '##@' and the
77-
# target descriptions by '##'. The awk commands is responsible for reading the
77+
# target descriptions by '##'. The awk command is responsible for reading the
7878
# entire set of makefiles included in this invocation, looking for lines of the
7979
# file as xyz: ## something, and then pretty-format the target and help. Then,
8080
# if there's a line with ##@ something, that gets pretty-printed as a category.

pkg/plugins/golang/v3/scaffolds/internal/templates/makefile.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ all: build
8383
8484
# The help target prints out all targets with their descriptions organized
8585
# beneath their categories. The categories are represented by '##@' and the
86-
# target descriptions by '##'. The awk commands is responsible for reading the
86+
# target descriptions by '##'. The awk command is responsible for reading the
8787
# entire set of makefiles included in this invocation, looking for lines of the
8888
# file as xyz: ## something, and then pretty-format the target and help. Then,
8989
# if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -128,8 +128,8 @@ build: manifests generate fmt vet ## Build manager binary.
128128
run: manifests generate fmt vet ## Run a controller from your host.
129129
go run ./main.go
130130
131-
# If you wish built the manager image targeting other platforms you can use the --platform flag.
132-
# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
131+
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
132+
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
133133
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
134134
.PHONY: docker-build
135135
docker-build: test ## Build docker image with the manager.
@@ -139,12 +139,12 @@ docker-build: test ## Build docker image with the manager.
139139
docker-push: ## Push docker image with the manager.
140140
docker push ${IMG}
141141
142-
# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
142+
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
143143
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
144-
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
145-
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
146-
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
147-
# To properly provided solutions that supports more than one platform you should use this option.
144+
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
145+
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
146+
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
147+
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
148148
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
149149
.PHONY: docker-buildx
150150
docker-buildx: test ## Build and push docker image for the manager for cross-platform support

pkg/plugins/golang/v4/scaffolds/internal/templates/makefile.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ all: build
8989
9090
# The help target prints out all targets with their descriptions organized
9191
# beneath their categories. The categories are represented by '##@' and the
92-
# target descriptions by '##'. The awk commands is responsible for reading the
92+
# target descriptions by '##'. The awk command is responsible for reading the
9393
# entire set of makefiles included in this invocation, looking for lines of the
9494
# file as xyz: ## something, and then pretty-format the target and help. Then,
9595
# if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -138,8 +138,8 @@ build: manifests generate fmt vet ## Build manager binary.
138138
run: manifests generate fmt vet ## Run a controller from your host.
139139
go run ./cmd/main.go
140140
141-
# If you wish built the manager image targeting other platforms you can use the --platform flag.
142-
# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
141+
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
142+
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
143143
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
144144
.PHONY: docker-build
145145
docker-build: test ## Build docker image with the manager.
@@ -149,12 +149,12 @@ docker-build: test ## Build docker image with the manager.
149149
docker-push: ## Push docker image with the manager.
150150
$(CONTAINER_TOOL) push ${IMG}
151151
152-
# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
152+
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
153153
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
154-
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
155-
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
156-
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
157-
# To properly provided solutions that supports more than one platform you should use this option.
154+
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
155+
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
156+
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
157+
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
158158
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
159159
.PHONY: docker-buildx
160160
docker-buildx: test ## Build and push docker image for the manager for cross-platform support

testdata/project-v2/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ all: build
1818

1919
# The help target prints out all targets with their descriptions organized
2020
# beneath their categories. The categories are represented by '##@' and the
21-
# target descriptions by '##'. The awk commands is responsible for reading the
21+
# target descriptions by '##'. The awk command is responsible for reading the
2222
# entire set of makefiles included in this invocation, looking for lines of the
2323
# file as xyz: ## something, and then pretty-format the target and help. Then,
2424
# if there's a line with ##@ something, that gets pretty-printed as a category.

testdata/project-v3/Makefile

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ all: build
2323

2424
# The help target prints out all targets with their descriptions organized
2525
# beneath their categories. The categories are represented by '##@' and the
26-
# target descriptions by '##'. The awk commands is responsible for reading the
26+
# target descriptions by '##'. The awk command is responsible for reading the
2727
# entire set of makefiles included in this invocation, looking for lines of the
2828
# file as xyz: ## something, and then pretty-format the target and help. Then,
2929
# if there's a line with ##@ something, that gets pretty-printed as a category.
@@ -68,8 +68,8 @@ build: manifests generate fmt vet ## Build manager binary.
6868
run: manifests generate fmt vet ## Run a controller from your host.
6969
go run ./main.go
7070

71-
# If you wish built the manager image targeting other platforms you can use the --platform flag.
72-
# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
71+
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
72+
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
7373
# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
7474
.PHONY: docker-build
7575
docker-build: test ## Build docker image with the manager.
@@ -79,12 +79,12 @@ docker-build: test ## Build docker image with the manager.
7979
docker-push: ## Push docker image with the manager.
8080
docker push ${IMG}
8181

82-
# PLATFORMS defines the target platforms for the manager image be build to provide support to multiple
82+
# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
8383
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
84-
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
85-
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
86-
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
87-
# To properly provided solutions that supports more than one platform you should use this option.
84+
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
85+
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
86+
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
87+
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
8888
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
8989
.PHONY: docker-buildx
9090
docker-buildx: test ## Build and push docker image for the manager for cross-platform support

0 commit comments

Comments
 (0)