Skip to content

Commit

Permalink
Ran buildah through codespell
Browse files Browse the repository at this point in the history
Thanks to Dmitry Smirnov @onlyjob for suggesting this tool.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
  • Loading branch information
rhatdan committed Nov 18, 2019
1 parent c5244fe commit 122dd5c
Show file tree
Hide file tree
Showing 21 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion buildah.go
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ type CommonBuildOptions struct {
ShmSize string
// Ulimit specifies resource limit options, in the form type:softlimit[:hardlimit].
// These types are recognized:
// "core": maximimum core dump size (ulimit -c)
// "core": maximum core dump size (ulimit -c)
// "cpu": maximum CPU time (ulimit -t)
// "data": maximum size of a process's data segment (ulimit -d)
// "fsize": maximum size of new files (ulimit -f)
Expand Down
4 changes: 2 additions & 2 deletions demos/buildah-bud-demo.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# buildah-bud-demo.sh
# author : ipbabble
# Assumptions install buildah, podman & docker
# Do NOT start the docker deamon
# Do NOT start the docker daemon
# Set some of the variables below

demoimg=buildahbuddemo
Expand Down Expand Up @@ -64,7 +64,7 @@ podman stop $containernum
podman rm $containernum
read -p "${cyan}Check that nginx is down${reset}"
curl localhost
read -p "${cyan}Start the Docker daemon. Using restart incase it is already started${reset}"
read -p "${cyan}Start the Docker daemon. Using restart in case it is already started${reset}"
systemctl restart docker
read -p "${red}List the Docker images in the repository - should be empty${reset}"
docker images
Expand Down
4 changes: 2 additions & 2 deletions demos/docker-compatibility-demo.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# docker-compatibility-demo.sh
# author : ipbabble
# Assumptions install buildah, podman & docker
# Do NOT start the docker deamon
# Do NOT start the docker daemon
# Set some of the variables below

demoimg=dockercompatibilitydemo
Expand Down Expand Up @@ -62,7 +62,7 @@ podman stop $containernum
podman rm $containernum
read -p "${cyan}Check that nginx is down${reset}"
curl localhost
read -p "${cyan}Start the Docker daemon. Using restart incase it is already started${reset}"
read -p "${cyan}Start the Docker daemon. Using restart in case it is already started${reset}"
systemctl restart docker
read -p "${red}List the Docker images in the repository - should be empty${reset}"
docker images
Expand Down
12 changes: 6 additions & 6 deletions docs/buildah-bud.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ specifying **--disable-compression=false**.

This is a Docker specific option to disable image verification to a Docker
registry and is not supported by Buildah. This flag is a NOOP and provided
soley for scripting compatibility.
solely for scripting compatibility.

**--dns**=[]

Expand Down Expand Up @@ -439,7 +439,7 @@ Require HTTPS and verify certificates when talking to container registries (defa
Specifies resource limits to apply to processes launched when processing `RUN` instructions.
This option can be specified multiple times. Recognized resource types
include:
"core": maximimum core dump size (ulimit -c)
"core": maximum core dump size (ulimit -c)
"cpu": maximum CPU time (ulimit -t)
"data": maximum size of a process's data segment (ulimit -d)
"fsize": maximum size of new files (ulimit -f)
Expand Down Expand Up @@ -469,7 +469,7 @@ process.
**--userns-uid-map** *mapping*

Directly specifies a UID mapping which should be used to set ownership, at the
filesytem level, on the working container's contents.
filesystem level, on the working container's contents.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.

Expand All @@ -490,7 +490,7 @@ use the same numeric values as the GID map.
**--userns-gid-map** *mapping*

Directly specifies a GID mapping which should be used to set ownership, at the
filesytem level, on the working container's contents.
filesystem level, on the working container's contents.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.

Expand All @@ -511,7 +511,7 @@ use the same numeric values as the UID map.
**--userns-uid-map-user** *user*

Specifies that a UID mapping which should be used to set ownership, at the
filesytem level, on the working container's contents, can be found in entries
filesystem level, on the working container's contents, can be found in entries
in the `/etc/subuid` file which correspond to the specified user.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.
Expand All @@ -522,7 +522,7 @@ suitable user name to use as the default setting for this option.
**--userns-gid-map-group** *group*

Specifies that a GID mapping which should be used to set ownership, at the
filesytem level, on the working container's contents, can be found in entries
filesystem level, on the working container's contents, can be found in entries
in the `/etc/subgid` file which correspond to the specified group.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.
Expand Down
10 changes: 5 additions & 5 deletions docs/buildah-from.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ Require HTTPS and verify certificates when talking to container registries (defa
Specifies resource limits to apply to processes launched during `buildah run`.
This option can be specified multiple times. Recognized resource types
include:
"core": maximimum core dump size (ulimit -c)
"core": maximum core dump size (ulimit -c)
"cpu": maximum CPU time (ulimit -t)
"data": maximum size of a process's data segment (ulimit -d)
"fsize": maximum size of new files (ulimit -f)
Expand Down Expand Up @@ -358,7 +358,7 @@ process.
**--userns-uid-map** *mapping*

Directly specifies a UID mapping which should be used to set ownership, at the
filesytem level, on the container's contents.
filesystem level, on the container's contents.
Commands run using `buildah run` will default to being run in their own user
namespaces, configured using the UID and GID maps.

Expand All @@ -379,7 +379,7 @@ use the same numeric values as the GID map.
**--userns-gid-map** *mapping*

Directly specifies a GID mapping which should be used to set ownership, at the
filesytem level, on the container's contents.
filesystem level, on the container's contents.
Commands run using `buildah run` will default to being run in their own user
namespaces, configured using the UID and GID maps.

Expand All @@ -400,7 +400,7 @@ use the same numeric values as the UID map.
**--userns-uid-map-user** *user*

Specifies that a UID mapping which should be used to set ownership, at the
filesytem level, on the container's contents, can be found in entries in the
filesystem level, on the container's contents, can be found in entries in the
`/etc/subuid` file which correspond to the specified user.
Commands run using `buildah run` will default to being run in their own user
namespaces, configured using the UID and GID maps.
Expand All @@ -411,7 +411,7 @@ suitable user name to use as the default setting for this option.
**--userns-gid-map-group** *group*

Specifies that a GID mapping which should be used to set ownership, at the
filesytem level, on the container's contents, can be found in entries in the
filesystem level, on the container's contents, can be found in entries in the
`/etc/subgid` file which correspond to the specified group.
Commands run using `buildah run` will default to being run in their own user
namespaces, configured using the UID and GID maps.
Expand Down
2 changes: 1 addition & 1 deletion docs/buildah-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Valid placeholders for the Go template are listed below:
| .ID | Image ID |
| .Name | Image Name |
| .Digest | Image Digest |
| .CreatedAt | Creation date Pretty Formated |
| .CreatedAt | Creation date Pretty Formatted |
| .Size | Image Size |
| .CreatedAtRaw | Creation date in raw format |
| .ReadOnly | Indicates if image came from a R/O store |
Expand Down
2 changes: 1 addition & 1 deletion docs/buildah-push.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ This example pushes the image specified by the imageID to a local directory in o

`# buildah push imageID oci:/path/to/layout:image:tag`

This example pushes the image specifed by the imageID to a tar archive in oci format.
This example pushes the image specified by the imageID to a tar archive in oci format.

`# buildah push imageID oci-archive:/path/to/archive:image:tag`

Expand Down
4 changes: 2 additions & 2 deletions docs/buildah.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Storage driver option, Default storage driver options are configured in /etc/con
**--userns-uid-map** *mapping*

Specifies UID mappings which should be used to set ownership, at the
filesytem level, on the contents of images and containers.
filesystem level, on the contents of images and containers.
Entries in this map take the form of one or more triples of a starting
in-container UID, a corresponding starting host-level UID, and the number of
consecutive IDs which the map entry represents.
Expand All @@ -80,7 +80,7 @@ This option overrides the *remap-uids* setting in the *options* section of
**--userns-gid-map** *mapping*

Specifies GID mappings which should be used to set ownership, at the
filesytem level, on the contents of images and containers.
filesystem level, on the contents of images and containers.
Entries in this map take the form of one or more triples of a starting
in-container GID, a corresponding starting host-level GID, and the number of
consecutive IDs which the map entry represents.
Expand Down
2 changes: 1 addition & 1 deletion docs/release-announcements/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ Features: SHELL command support in Dockerfiles, added support for three transpor

**[Buildah Alpha v0.12 RA](v0.12.md) - February 21, 2018**

Features: Set the default certificate directory to /etc/containers/certs.d, improved lookups for a variety of image name formats, added pruning capabilty to the rmi command, provided authentication to `buildah bud` and other enhancements and bug fixes.
Features: Set the default certificate directory to /etc/containers/certs.d, improved lookups for a variety of image name formats, added pruning capability to the rmi command, provided authentication to `buildah bud` and other enhancements and bug fixes.

## Buildah == Simplicity
2 changes: 1 addition & 1 deletion docs/release-announcements/v1.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The Buildah project has continued to grow over the past several weeks, welcoming

* Non-OCI command handling in a Dockerfile

If a command that is not OCI compliant is encountered when building an OCI formated container image, better error messages are now displayed. If a non-OCI formated container image is desired, the '--format=docker' option should be passed to the bud command.
If a command that is not OCI compliant is encountered when building an OCI formatted container image, better error messages are now displayed. If a non-OCI formatted container image is desired, the '--format=docker' option should be passed to the bud command.

* We've moved!

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/01-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The purpose of this tutorial is to demonstrate how Buildah can be used to build

In brief the `containers/image` project provides mechanisms to copy, push, pull, inspect and sign container images. The `containers/storage` project provides mechanisms for storing filesystem layers, container images, and containers. Buildah is a CLI that takes advantage of these underlying projects and therefore allows you to build, move, and manage container images and containers.

Buildah works on a number of Linux distributions, but is not supported on Windows or Mac platforms at this time. Buildah specializes in building OCI images and [Podman](https://podman.io) specializes in all of the commands and functions that help you to maintain, modify and run OCI images and containers. For more informaton on the difference between the projects please refer to the [Buildah and Podman relationship](https://github.com/containers/buildah#buildah-and-podman-relationship) section on the main README.md.
Buildah works on a number of Linux distributions, but is not supported on Windows or Mac platforms at this time. Buildah specializes in building OCI images and [Podman](https://podman.io) specializes in all of the commands and functions that help you to maintain, modify and run OCI images and containers. For more information on the difference between the projects please refer to the [Buildah and Podman relationship](https://github.com/containers/buildah#buildah-and-podman-relationship) section on the main README.md.

## Configure and Install Buildah

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/02-registries-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ First we must pull down a registry. As a shortcut we will save the container nam

# registry=$(buildah from registry)

It is worth pointing out that the `from` command can also use other protocols beyond the default (and implicity assumed) order that first looks in local containers-storage (containers-storage:) and then looks in the Docker hub (docker:). For example, if you already had a registry container image in a local Docker registry then you could use the following:
It is worth pointing out that the `from` command can also use other protocols beyond the default (and implicitly assumed) order that first looks in local containers-storage (containers-storage:) and then looks in the Docker hub (docker:). For example, if you already had a registry container image in a local Docker registry then you could use the following:

# registry=$(buildah from docker-daemon:registry:latest)

Expand Down
2 changes: 1 addition & 1 deletion hack/get_ci_vm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ echo -e "\n${YEL}Removing and re-creating $GOSRC on $VMNAME.${NOR}"
showrun $SSH_CMD --command "rm -rf $GOSRC"
showrun $SSH_CMD --command "mkdir -p $GOSRC"

echo -e "\n${YEL}Transfering tarball to $VMNAME.${NOR}"
echo -e "\n${YEL}Transferring tarball to $VMNAME.${NOR}"
wait
showrun $SCP_CMD $HOME/$TARBALL $SSHUSER@$VMNAME:/tmp/$TARBALL

Expand Down
2 changes: 1 addition & 1 deletion install.md
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ cat /etc/containers/policy.json

## Vendoring

Buildah uses Go Modules for vendoring purposes. If you need to update or add a vendored package into Buildah, please follow this proceedure:
Buildah uses Go Modules for vendoring purposes. If you need to update or add a vendored package into Buildah, please follow this procedure:
* Enter into your sandbox `src/github.com/containers/buildah` and ensure that the GOPATH variable is set to the directory prior as noted above.
* `export GO111MODULE=on`
* Assuming you want to 'bump' the `github.com/containers/storage` package to version 1.12.13, use this command: `go get github.com/containers/storage@v1.12.13`
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ func GetFromAndBudFlags(flags *FromAndBudResults, usernsResults *UserNSResults,
fs.StringSliceVar(&flags.DNSSearch, "dns-search", []string{}, "Set custom DNS search domains")
fs.StringSliceVar(&flags.DNSServers, "dns", []string{}, "Set custom DNS servers or disable it completely by setting it to 'none', which prevents the automatic creation of `/etc/resolv.conf`.")
fs.StringSliceVar(&flags.DNSOptions, "dns-option", []string{}, "Set custom DNS options")
fs.BoolVar(&flags.HTTPProxy, "http-proxy", true, "pass thru HTTP Proxy environment variables")
fs.BoolVar(&flags.HTTPProxy, "http-proxy", true, "pass through HTTP Proxy environment variables")
fs.StringVar(&flags.Isolation, "isolation", DefaultIsolation(), "`type` of process isolation to use. Use BUILDAH_ISOLATION environment variable to override.")
fs.StringVarP(&flags.Memory, "memory", "m", "", "memory limit (format: <number>[<unit>], where unit = b, k, m or g)")
fs.StringVar(&flags.MemorySwap, "memory-swap", "", "swap limit equal to memory plus swap: '-1' to enable unlimited swap")
Expand Down
2 changes: 1 addition & 1 deletion pkg/parse/parse.go
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ func getMounts(mounts []string) (map[string]specs.Mount, error) {

// TODO(vrothberg): the manual parsing can be replaced with a regular expression
// to allow a more robust parsing of the mount format and to give
// precise errors regarding supported format versus suppored options.
// precise errors regarding supported format versus supported options.
for _, mount := range mounts {
arr := strings.SplitN(mount, ",", 2)
if len(arr) < 2 {
Expand Down
12 changes: 6 additions & 6 deletions tests/conformance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The conformance test for `buildah bud` is used to verify the images built with B

## Installing dependencies

The dependencies for comformance testing include two parts:
The dependencies for conformance testing include two parts:
* Binary required by the conformance test suite:
* docker
* podman
Expand All @@ -24,7 +24,7 @@ Conformance tests use Docker CE to check the images built with Buildah. Install

### Install Podman

[Podman](https://github.com/containers/libpod) is used to push images built with Buildah to the docker deamon. It can be installed with dnf or yum in Fedora, RHEL and CentOS, it also can be installed from source code. If you want to install Podman from source code, please follow the [libpod Installation Instructions](https://github.com/containers/libpod/blob/master/install.md).
[Podman](https://github.com/containers/libpod) is used to push images built with Buildah to the docker daemon. It can be installed with dnf or yum in Fedora, RHEL and CentOS, it also can be installed from source code. If you want to install Podman from source code, please follow the [libpod Installation Instructions](https://github.com/containers/libpod/blob/master/install.md).

### Install container-diff

Expand Down Expand Up @@ -55,7 +55,7 @@ or
go test -v ./tests/conformance
```

If you wan to run one of the test cases you can use flag "-focus":
If you want to run one of the test cases you can use flag "-focus":
```
ginkgo -v -focus "shell test" test/conformance
```
Expand All @@ -65,15 +65,15 @@ go test -c ./tests/conformance
./conformance.test -ginkgo.v -ginkgo.focus "shell test"
```

There are also some environment varibles that can be set during the test:
There are also some environment variables that can be set during the test:

| Varible Name | Useage |
| Variable Name | Usage |
| :------------------------ | :-------------------------------------------------------- |
| BUILDAH\_BINARY | Used to set the Buildah binary path. Can be used for test installed rpm |
| TEST\_DATA\_DIR | Test data directory include the Dockerfiles and related files |
| DOCKER\_BINARY | Docker binary path. |
| BUILDAH\_$SUBCMD\_OPTIONS | Command line options for each Buildah command. $SUBCMD is the short command from "buildah -h". |
| $GLOBALOPTIONS | Global options from "buildah -h". The Varible Name is the option name which replace "-" with "\_" and with upper case |
| $GLOBALOPTIONS | Global options from "buildah -h". The Variable Name is the option name which replace "-" with "\_" and with upper case |

Example to run conformance test for buildah bud with --format=docker:
```
Expand Down
4 changes: 2 additions & 2 deletions tests/from.bats
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ load helpers
@test "from-authenticate-cert" {

mkdir -p ${TESTDIR}/auth
# Create certifcate via openssl
# Create certificate via openssl
openssl req -newkey rsa:4096 -nodes -sha256 -keyout ${TESTDIR}/auth/domain.key -x509 -days 2 -out ${TESTDIR}/auth/domain.crt -subj "/C=US/ST=Foo/L=Bar/O=Red Hat, Inc./CN=localhost"
# Skopeo and buildah both require *.cert file
cp ${TESTDIR}/auth/domain.crt ${TESTDIR}/auth/domain.cert
Expand Down Expand Up @@ -89,7 +89,7 @@ load helpers
mkdir -p ${TESTDIR}/auth
# Create creds and store in ${TESTDIR}/auth/htpasswd
# docker run --entrypoint htpasswd registry:2 -Bbn testuser testpassword > ${TESTDIR}/auth/htpasswd
# Create certifcate via openssl
# Create certificate via openssl
openssl req -newkey rsa:4096 -nodes -sha256 -keyout ${TESTDIR}/auth/domain.key -x509 -days 2 -out ${TESTDIR}/auth/domain.crt -subj "/C=US/ST=Foo/L=Bar/O=Red Hat, Inc./CN=localhost"
# Skopeo and buildah both require *.cert file
cp ${TESTDIR}/auth/domain.crt ${TESTDIR}/auth/domain.cert
Expand Down
Loading

0 comments on commit 122dd5c

Please sign in to comment.