Merge pull request containers#19323 from eriksjolund/fix_language_typ…

…os_markdown_layout

Fix language, typos and markdown layout

cmd/podman/kube/play.go

@@ -319,7 +319,7 @@ func play(cmd *cobra.Command, args []string) error {
 		// rerunning the same YAML file will cause an error and remove
 		// the previously created workload.
 		//
-		// teardown any containers, pods, and volumes that might have created before we hit the error
+		// teardown any containers, pods, and volumes that might have been created before we hit the error
 		// reader, err := readerFromArg(args[0])
 		// if err != nil {
 		// 	return err

docs/source/markdown/podman-logs.1.md.in

@@ -68,7 +68,7 @@ podman logs -t --since 0 myserver
 1:M 07 Aug 14:10:09.056 # Server initialized
 ```
 
-To view a containers logs since a certain time:
+To view a container's logs since a certain time:
 ```
 podman logs -t --since 2017-08-07T10:10:09.055837383-04:00 myserver
 

docs/source/markdown/podman-machine-os-apply.1.md

@@ -13,7 +13,7 @@ Apply machine OS changes from an OCI image.
 VM's that use OS's that use rpm-ostreee have the capability to rebase itself from the content of an OCI image.
 `podman machine image apply` takes an OCI image with container native ostree functionality and rebases itself on that image.
 
-By default, Podman machines on Mac and Linux use an rpm-ostree based distrubition (Fedora CoreOS).
+By default, Podman machines on Mac and Linux use an rpm-ostree based distribution (Fedora CoreOS).
 
 For more information, please see the [rpm-ostree docs](https://coreos.github.io/rpm-ostree/container/).
 

docs/source/markdown/podman-manifest-push.1.md.in

@@ -53,7 +53,7 @@ Sign the pushed images with a “simple signing” signature using the specified
 
 #### **--sign-by-sigstore**=*param-file***
 
-Add a sigstore signature based on further options specified in a containers sigstore signing parameter file *param-file*.
+Add a sigstore signature based on further options specified in a container's sigstore signing parameter file *param-file*.
 See containers-sigstore-signing-params.yaml(5) for details about the file format.
 
 #### **--sign-by-sigstore-private-key**=*path*

docs/source/markdown/podman-network-create.1.md

@@ -56,7 +56,7 @@ Note, trying to create a network with an existing name and different parameters
 
 #### **--interface-name**=*name*
 
-This option maps the the *network_interface* option in the network config, see **podman network inspect**.
+This option maps the *network_interface* option in the network config, see **podman network inspect**.
 Depending on the driver, this can have different effects; for `bridge`, it uses the bridge interface name.
 For `macvlan` and `ipvlan`, it is the parent device on the host. It is the same as `--opt parent=...`.
 

docs/source/markdown/podman-push.1.md.in

@@ -88,7 +88,7 @@ Add a “simple signing” signature at the destination using the specified key.
 
 #### **--sign-by-sigstore**=*param-file***
 
-Add a sigstore signature based on further options specified in a containers sigstore signing parameter file *param-file*.
+Add a sigstore signature based on further options specified in a container's sigstore signing parameter file *param-file*.
 See containers-sigstore-signing-params.yaml(5) for details about the file format.
 
 #### **--sign-by-sigstore-private-key**=*path*

docs/source/markdown/podman-remote.1.md

@@ -151,7 +151,7 @@ the exit codes follow the `chroot` standard, see below:
 | [podman-diff(1)](podman-diff.1.md)               | Inspect changes on a container or image's filesystem.                       |
 | [podman-events(1)](podman-events.1.md)           | Monitor Podman events                                                       |
 | [podman-export(1)](podman-export.1.md)           | Export a container's filesystem contents as a tar archive.                  |
-| [podman-generate(1)](podman-generate.1.md)       | Generate structured data based for a containers and pods.                   |
+| [podman-generate(1)](podman-generate.1.md)       | Generate structured data based on containers and pods.                   |
 | [podman-healthcheck(1)](podman-healthcheck.1.md) | Manage healthchecks for containers                                          |
 | [podman-history(1)](podman-history.1.md)         | Show the history of an image.                                               |
 | [podman-image(1)](podman-image.1.md)             | Manage images.                                                              |

docs/source/markdown/podman-system-connection-add.1.md

@@ -13,7 +13,7 @@ Record ssh destination for remote podman service(s). The ssh destination is give
  - unix://path
  - tcp://hostname:port
 
-The user is prompted for the remote ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running.
+The user is prompted for the remote ssh login password or key file passphrase as required. The `ssh-agent` is supported if it is running.
 
 ## OPTIONS
 

docs/source/markdown/podman-system-connection.1.md

@@ -9,7 +9,7 @@ podman\-system\-connection - Manage the destination(s) for Podman service(s)
 ## DESCRIPTION
 Manage the destination(s) for Podman service(s).
 
-The user is prompted for the ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running.
+The user is prompted for the ssh login password or key file passphrase as required. The `ssh-agent` is supported if it is running.
 
 ## COMMANDS
 

docs/source/markdown/podman-systemd.unit.5.md

@@ -386,7 +386,7 @@ setuid and file capabilities.
 
 The rootfs to use for the container. Rootfs points to a directory on the system that contains the content to be run within the container. This option conflicts with the `Image` option.
 
-The format of the rootfs is the same as when passed to `podman run --rootfs`, so it supports ovelay mounts as well.
+The format of the rootfs is the same as when passed to `podman run --rootfs`, so it supports overlay mounts as well.
 
 Note: On SELinux systems, the rootfs needs the correct label, which is by default unconfined_u:object_r:container_file_t:s0.
 
@@ -404,7 +404,7 @@ of startup on its own.
 This key contains a list of arguments passed directly to the end of the `podman run` command
 in the generated file (right before the image name in the command line). It can be used to
 access Podman features otherwise unsupported by the generator. Since the generator is unaware
-of what unexpected interactions can be caused by these arguments, is not recommended to use
+of what unexpected interactions can be caused by these arguments, it is not recommended to use
 this option.
 
 The format of this is a space separated list of arguments, which can optionally be individually
@@ -569,7 +569,7 @@ Indicates whether containers will be auto-updated ([podman-auto-update(1)](podma
 
 ### `ConfigMap=`
 
-Pass the Kubernetes ConfigMap YAML at path to `podman kube play` via the `--configmap` argument.
+Pass the Kubernetes ConfigMap YAML path to `podman kube play` via the `--configmap` argument.
 Unlike the `configmap` argument, the value may contain only one path but
 it may be absolute or relative to the location of the unit file.
 

docs/source/markdown/podman.1.md

@@ -27,7 +27,7 @@ man pages.
 
 #### **--cgroup-manager**=*manager*
 
-The CGroup manager to use for container cgroups. Supported values are cgroupfs or systemd. Default is systemd unless overridden in the containers.conf file.
+The CGroup manager to use for container cgroups. Supported values are __cgroupfs__ or __systemd__. Default is _systemd_ unless overridden in the containers.conf file.
 
 Note: Setting this flag can cause certain commands to break when called on containers previously created by the other CGroup manager type.
 Note: CGroup manager is not supported in rootless mode when using CGroups Version V1.
@@ -86,7 +86,7 @@ This will override *imagestore* option in `containers-storage.conf(5)`, refer to
 
 #### **--log-level**=*level*
 
-Log messages at and above specified level: debug, info, warn, error, fatal or panic (default: "warn")
+Log messages at and above specified level: __debug__, __info__, __warn__, __error__, __fatal__ or __panic__ (default: _warn_)
 
 #### **--network-cmd-path**=*path*
 Path to the `slirp4netns(1)` command binary to use for setting up a slirp4netns network.

docs/tutorials/qemu-remote-tutorial.md

@@ -14,7 +14,7 @@ The officially supported and recommended way of running Podman on Windows is usi
 * Windows 10 Build 18362 or later (Build 19044/Version 21H2 or later recommended)
 * SSH client feature installed on the machine
 * Hyper-V acceleration should be operational on the machine
-* Direcroty `C:\qemu-remote\` will be used for storing needed assets
+* Directory `C:\qemu-remote\` will be used for storing needed assets
 * Port `57561` is free to use for ssh over a loopback interface
 
 ## Obtaining and installing

libpod/container_api.go

@@ -797,7 +797,7 @@ func (c *Container) Cleanup(ctx context.Context) error {
 		defer c.lock.Unlock()
 
 		if err := c.syncContainer(); err != nil {
-			// When the container has already been removed, the OCI runtime directory remain.
+			// When the container has already been removed, the OCI runtime directory remains.
 			if errors.Is(err, define.ErrNoSuchCtr) || errors.Is(err, define.ErrCtrRemoved) {
 				if err := c.cleanupRuntime(ctx); err != nil {
 					return fmt.Errorf("cleaning up container %s from OCI runtime: %w", c.ID(), err)

libpod/container_exec.go

@@ -862,7 +862,7 @@ func (c *Container) cleanupExecBundle(sessionID string) (err error) {
 	return
 }
 
-// the path to a containers exec session bundle
+// the path to a container's exec session bundle
 func (c *Container) execBundlePath(sessionID string) string {
 	return filepath.Join(c.bundlePath(), sessionID)
 }

libpod/container_log.go

@@ -33,7 +33,7 @@ func (r *Runtime) Log(ctx context.Context, containers []*Container, options *log
 	return nil
 }
 
-// ReadLog reads a containers log based on the input options and returns log lines over a channel.
+// ReadLog reads a container's log based on the input options and returns log lines over a channel.
 func (c *Container) ReadLog(ctx context.Context, options *logs.LogOptions, logChannel chan *logs.LogLine, colorID int64) error {
 	switch c.LogDriver() {
 	case define.PassthroughLogging:

libpod/define/containerstate.go

@@ -69,7 +69,7 @@ func (t ContainerStatus) String() string {
 	return "bad state"
 }
 
-// StringToContainerStatus converts a string representation of a containers
+// StringToContainerStatus converts a string representation of a container's
 // status into an actual container status type
 func StringToContainerStatus(status string) (ContainerStatus, error) {
 	switch status {

libpod/events/config.go

@@ -184,7 +184,7 @@ const (
 	// Renumber indicates that lock numbers were reallocated at user
 	// request.
 	Renumber Status = "renumber"
-	// Restart indicates the target was restarted via an API call.
+	// Restart indicates that the target was restarted via an API call.
 	Restart Status = "restart"
 	// Restore ...
 	Restore Status = "restore"

libpod/events/journal_linux.go

@@ -226,9 +226,9 @@ func (e EventJournalD) String() string {
 	return Journald.String()
 }
 
-// GetNextEntry returns the next entry in the journal. If the end  of the
+// GetNextEntry returns the next entry in the journal. If the end of the
 // journal is reached and stream is not set or the current time is after
-// the until time this function return nil,nil.
+// the until time this function returns nil,nil.
 func GetNextEntry(ctx context.Context, j *sdjournal.Journal, stream bool, untilTime time.Time) (*sdjournal.JournalEntry, error) {
 	for {
 		select {

libpod/healthcheck.go

@@ -350,7 +350,7 @@ func (c *Container) updateHealthStatus(status string) error {
 	return os.WriteFile(c.healthCheckLogPath(), newResults, 0700)
 }
 
-// isUnhealthy returns if the current health check status in unhealthy.
+// isUnhealthy returns true if the current health check status is unhealthy.
 func (c *Container) isUnhealthy() (bool, error) {
 	if !c.HasHealthCheck() {
 		return false, nil

libpod/networking_common.go

@@ -23,7 +23,7 @@ import (
 )
 
 // convertPortMappings will remove the HostIP part from the ports when running inside podman machine.
-// This is need because a HostIP of 127.0.0.1 would now allow the gvproxy forwarder to reach to open ports.
+// This is needed because a HostIP of 127.0.0.1 would now allow the gvproxy forwarder to reach to open ports.
 // For machine the HostIP must only be used by gvproxy and never in the VM.
 func (c *Container) convertPortMappings() []types.PortMapping {
 	if !machine.IsGvProxyBased() || len(c.config.PortMappings) == 0 {
@@ -174,10 +174,10 @@ func (r *Runtime) reloadContainerNetwork(ctr *Container) (map[string]types.Statu
 
 	err := r.teardownNetwork(ctr)
 	if err != nil {
-		// teardownNetwork will error if the iptables rules do not exists and this is the case after
+		// teardownNetwork will error if the iptables rules do not exist and this is the case after
 		// a firewall reload. The purpose of network reload is to recreate the rules if they do
 		// not exists so we should not log this specific error as error. This would confuse users otherwise.
-		// iptables-legacy and iptables-nft will create different errors make sure to match both.
+		// iptables-legacy and iptables-nft will create different errors. Make sure to match both.
 		b, rerr := regexp.MatchString("Couldn't load target `CNI-[a-f0-9]{24}':No such file or directory|Chain 'CNI-[a-f0-9]{24}' does not exist", err.Error())
 		if rerr == nil && !b {
 			logrus.Error(err)

libpod/networking_unsupported.go

@@ -80,7 +80,7 @@ func (r *Runtime) GetRootlessNetNs(new bool) (*RootlessNetNS, error) {
 }
 
 // convertPortMappings will remove the HostIP part from the ports when running inside podman machine.
-// This is need because a HostIP of 127.0.0.1 would now allow the gvproxy forwarder to reach to open ports.
+// This is needed because a HostIP of 127.0.0.1 would now allow the gvproxy forwarder to reach to open ports.
 // For machine the HostIP must only be used by gvproxy and never in the VM.
 func (c *Container) convertPortMappings() []types.PortMapping {
 	return []types.PortMapping{}

libpod/runtime_ctr.go

@@ -945,7 +945,7 @@ func (r *Runtime) removeContainer(ctx context.Context, c *Container, opts ctrRmO
 		// Do a quick ping of the database to check if the container
 		// still exists.
 		if ok, _ := r.state.HasContainer(c.ID()); !ok {
-			// When the container has already been removed, the OCI runtime directory remain.
+			// When the container has already been removed, the OCI runtime directory remains.
 			if err := c.cleanupRuntime(ctx); err != nil {
 				retErr = fmt.Errorf("cleaning up container %s from OCI runtime: %w", c.ID(), err)
 				return

pkg/domain/infra/tunnel/helpers.go

@@ -52,7 +52,7 @@ func getContainersAndInputByContext(contextWithConnection context.Context, all,
 	for _, nameOrID := range namesOrIDs {
 		// First determine if the container exists by doing an inspect.
 		// Inspect takes supports names and IDs and let's us determine
-		// a containers full ID.
+		// a container's full ID.
 		inspectData, err := containers.Inspect(contextWithConnection, nameOrID, new(containers.InspectOptions).WithSize(false))
 		if err != nil {
 			if ignore && errorhandling.Contains(err, define.ErrNoSuchCtr) {
@@ -104,7 +104,7 @@ func getPodsByContext(contextWithConnection context.Context, all bool, namesOrID
 	for _, nameOrID := range namesOrIDs {
 		// First determine if the pod exists by doing an inspect.
 		// Inspect takes supports names and IDs and let's us determine
-		// a containers full ID.
+		// a container's full ID.
 		inspectData, err := pods.Inspect(contextWithConnection, nameOrID, nil)
 		if err != nil {
 			if errorhandling.Contains(err, define.ErrNoSuchPod) {