mirror of
https://github.com/containers/podman
synced 2024-10-19 00:34:18 +00:00
[CI:DOCS] Fix spelling and typos
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
This commit is contained in:
parent
cea9340242
commit
72966a32cd
|
@ -188,7 +188,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
|
|||
// A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
|
||||
// - `is-automated=(true|false)`
|
||||
// - `is-official=(true|false)`
|
||||
// - `stars=<number>` Matches images that has at least 'number' stars.
|
||||
// - `stars=<number>` Matches images that have at least 'number' stars.
|
||||
// - in: query
|
||||
// name: tlsVerify
|
||||
// type: boolean
|
||||
|
@ -503,7 +503,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
|
|||
// name: t
|
||||
// type: string
|
||||
// default: latest
|
||||
// description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default latest value is assumed. You can provide several t parameters.
|
||||
// description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default latest value is assumed. You can provide several t parameters.
|
||||
// - in: query
|
||||
// name: extrahosts
|
||||
// type: string
|
||||
|
@ -1116,7 +1116,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
|
|||
// A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters:
|
||||
// - `is-automated=(true|false)`
|
||||
// - `is-official=(true|false)`
|
||||
// - `stars=<number>` Matches images that has at least 'number' stars.
|
||||
// - `stars=<number>` Matches images that have at least 'number' stars.
|
||||
// - in: query
|
||||
// name: tlsVerify
|
||||
// type: boolean
|
||||
|
@ -1406,7 +1406,7 @@ func (s *APIServer) registerImagesHandlers(r *mux.Router) error {
|
|||
// name: t
|
||||
// type: string
|
||||
// default: latest
|
||||
// description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default latest value is assumed. You can provide several t parameters.
|
||||
// description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default latest value is assumed. You can provide several t parameters.
|
||||
// - in: query
|
||||
// name: allplatforms
|
||||
// type: boolean
|
||||
|
|
|
@ -274,7 +274,7 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
|
|||
// - `id=[id]` Matches for full or partial ID.
|
||||
// - `driver=[driver]` Only bridge is supported.
|
||||
// - `label=[key]` or `label=[key=value]` Matches networks based on the presence of a label alone or a label and a value.
|
||||
// - `until=[timestamp]` Matches all networks that were create before the given timestamp.
|
||||
// - `until=[timestamp]` Matches all networks that were created before the given timestamp.
|
||||
// produces:
|
||||
// - application/json
|
||||
// responses:
|
||||
|
|
|
@ -227,7 +227,7 @@ func encodeMultiAuthConfigs(authConfigs map[string]types.DockerAuthConfig) (stri
|
|||
}
|
||||
|
||||
// authConfigsToAuthFile stores the specified auth configs in a temporary files
|
||||
// and returns its path. The file can later be used an auth file for contacting
|
||||
// and returns its path. The file can later be used as an auth file for contacting
|
||||
// one or more container registries. If tmpDir is empty, the system's default
|
||||
// TMPDIR will be used.
|
||||
func authConfigsToAuthFile(authConfigs map[string]types.DockerAuthConfig) (string, error) {
|
||||
|
@ -284,7 +284,7 @@ func normalizeAuthFileKey(authFileKey string) string {
|
|||
// dockerAuthToImageAuth converts a docker auth config to one we're using
|
||||
// internally from c/image. Note that the Docker types look slightly
|
||||
// different, so we need to convert to be extra sure we're not running into
|
||||
// undesired side-effects when unmarhalling directly to our types.
|
||||
// undesired side-effects when unmarshalling directly to our types.
|
||||
func dockerAuthToImageAuth(authConfig dockerAPITypes.AuthConfig) types.DockerAuthConfig {
|
||||
return types.DockerAuthConfig{
|
||||
Username: authConfig.Username,
|
||||
|
|
|
@ -117,7 +117,7 @@ func CRImportCheckpoint(ctx context.Context, runtime *libpod.Runtime, restoreOpt
|
|||
|
||||
// According to podman pod create a pod can share the following namespaces:
|
||||
// cgroup, ipc, net, pid, uts
|
||||
// Let's make sure we a restoring into a pod with the same shared namespaces.
|
||||
// Let's make sure we are restoring into a pod with the same shared namespaces.
|
||||
pod, err := runtime.LookupPod(ctrConfig.Pod)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("pod %q cannot be retrieved: %w", ctrConfig.Pod, err)
|
||||
|
@ -128,7 +128,7 @@ func CRImportCheckpoint(ctx context.Context, runtime *libpod.Runtime, restoreOpt
|
|||
return nil, fmt.Errorf("cannot retrieve infra container from pod %q: %w", ctrConfig.Pod, err)
|
||||
}
|
||||
|
||||
// If a namespaces was shared (!= "") it needs to be set to the new infrastructure container
|
||||
// If a namespace was shared (!= "") it needs to be set to the new infrastructure container.
|
||||
// If the infrastructure container does not share the same namespaces as the to be restored
|
||||
// container we abort.
|
||||
if ctrConfig.IPCNsCtr != "" {
|
||||
|
|
|
@ -15,7 +15,7 @@ import (
|
|||
"github.com/opencontainers/selinux/go-selinux/label"
|
||||
)
|
||||
|
||||
// This file mainly exist to make the checkpoint/restore functions
|
||||
// This file mainly exists to make the checkpoint/restore functions
|
||||
// available for other users. One possible candidate would be CRI-O.
|
||||
|
||||
// CRImportCheckpointWithoutConfig imports the checkpoint archive (input)
|
||||
|
@ -207,7 +207,7 @@ func CRCreateFileWithLabel(directory, fileName, fileLabel string) error {
|
|||
|
||||
// CRRuntimeSupportsCheckpointRestore tests if the given runtime at 'runtimePath'
|
||||
// supports checkpointing. The checkpoint restore interface has no definition
|
||||
// but crun implements all commands just as runc does. Whathh runc does it the
|
||||
// but crun implements all commands just as runc does. What runc does is the
|
||||
// official definition of the checkpoint/restore interface.
|
||||
func CRRuntimeSupportsCheckpointRestore(runtimePath string) bool {
|
||||
// Check if the runtime implements checkpointing. Currently only
|
||||
|
|
2
pkg/env/env_windows.go
vendored
2
pkg/env/env_windows.go
vendored
|
@ -8,7 +8,7 @@ func ParseSlice(s []string) (map[string]string, error) {
|
|||
if len(e) > 0 && e[0] == '=' {
|
||||
// The legacy Windows CMD command interpreter uses a hack, where to emulate
|
||||
// DOS semantics, it uses an illegal (by windows definition) env name for
|
||||
// state storage to avoid conlficting with user defined env names. This is
|
||||
// state storage to avoid conflicting with user defined env names. This is
|
||||
// used to preserve drive letter paths. E.g., typing c: from another drive
|
||||
// will remember the last CWD because CMD stores it in an env named "=C:".
|
||||
// Since these are illegal, they are filtered from standard user access but
|
||||
|
|
|
@ -525,7 +525,7 @@ type RollingUpdateDaemonSet struct {
|
|||
MaxUnavailable *intstr.IntOrString `json:"maxUnavailable,omitempty"`
|
||||
|
||||
// The maximum number of nodes with an existing available DaemonSet pod that
|
||||
// can have an updated DaemonSet pod during during an update.
|
||||
// can have an updated DaemonSet pod during an update.
|
||||
// Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%).
|
||||
// This can not be 0 if MaxUnavailable is 0.
|
||||
// Absolute number is calculated from percentage by rounding up to a minimum of 1.
|
||||
|
@ -537,7 +537,7 @@ type RollingUpdateDaemonSet struct {
|
|||
// pod is available (Ready for at least minReadySeconds) the old DaemonSet pod
|
||||
// on that node is marked deleted. If the old pod becomes unavailable for any
|
||||
// reason (Ready transitions to false, is evicted, or is drained) an updated
|
||||
// pod is immediatedly created on that node without considering surge limits.
|
||||
// pod is immediately created on that node without considering surge limits.
|
||||
// Allowing surge implies the possibility that the resources consumed by the
|
||||
// daemonset on any given node can double if the readiness check fails, and
|
||||
// so resource intensive daemonsets should take into account that they may
|
||||
|
@ -777,7 +777,7 @@ type ReplicaSetSpec struct {
|
|||
|
||||
// ReplicaSetStatus represents the current status of a ReplicaSet.
|
||||
type ReplicaSetStatus struct {
|
||||
// Replicas is the most recently oberved number of replicas.
|
||||
// Replicas is the most recently observed number of replicas.
|
||||
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller
|
||||
Replicas int32 `json:"replicas"`
|
||||
|
||||
|
|
|
@ -121,7 +121,7 @@ const (
|
|||
EndpointsLastChangeTriggerTime = "endpoints.kubernetes.io/last-change-trigger-time"
|
||||
|
||||
// EndpointsOverCapacity will be set on an Endpoints resource when it
|
||||
// exceeds the maximum capacity of 1000 addresses. Inititially the Endpoints
|
||||
// exceeds the maximum capacity of 1000 addresses. Initially the Endpoints
|
||||
// controller will set this annotation with a value of "warning". In a
|
||||
// future release, the controller may set this annotation with a value of
|
||||
// "truncated" to indicate that any addresses exceeding the limit of 1000
|
||||
|
|
|
@ -324,7 +324,7 @@ const (
|
|||
PersistentVolumeClaimFileSystemResizePending PersistentVolumeClaimConditionType = "FileSystemResizePending"
|
||||
)
|
||||
|
||||
// PersistentVolumeClaimCondition contails details about state of pvc
|
||||
// PersistentVolumeClaimCondition contains details about state of pvc
|
||||
type PersistentVolumeClaimCondition struct {
|
||||
Type PersistentVolumeClaimConditionType `json:"type"`
|
||||
Status ConditionStatus `json:"status"`
|
||||
|
@ -1249,7 +1249,7 @@ type Container struct {
|
|||
// sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
|
||||
// first client attaches to stdin, and then remains open and accepts data until the client disconnects,
|
||||
// at which time stdin is closed and remains closed until the container is restarted. If this
|
||||
// flag is false, a container processes that reads from stdin will never receive an EOF.
|
||||
// flag is false, a container process that reads from stdin will never receive an EOF.
|
||||
// Default is false
|
||||
// +optional
|
||||
StdinOnce bool `json:"stdinOnce,omitempty"`
|
||||
|
@ -2367,7 +2367,7 @@ type EphemeralContainerCommon struct {
|
|||
// sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
|
||||
// first client attaches to stdin, and then remains open and accepts data until the client disconnects,
|
||||
// at which time stdin is closed and remains closed until the container is restarted. If this
|
||||
// flag is false, a container processes that reads from stdin will never receive an EOF.
|
||||
// flag is false, a container process that reads from stdin will never receive an EOF.
|
||||
// Default is false
|
||||
// +optional
|
||||
StdinOnce bool `json:"stdinOnce,omitempty"`
|
||||
|
@ -2393,7 +2393,7 @@ var _ = Container(EphemeralContainerCommon{})
|
|||
type EphemeralContainer struct {
|
||||
// Ephemeral containers have all of the fields of Container, plus additional fields
|
||||
// specific to ephemeral containers. Fields in common with Container are in the
|
||||
// following inlined struct so than an EphemeralContainer may easily be converted
|
||||
// following inlined struct so that an EphemeralContainer may easily be converted
|
||||
// to a Container.
|
||||
EphemeralContainerCommon `json:",inline"`
|
||||
|
||||
|
@ -2639,7 +2639,7 @@ type ReplicationControllerSpec struct {
|
|||
// ReplicationControllerStatus represents the current status of a replication
|
||||
// controller.
|
||||
type ReplicationControllerStatus struct {
|
||||
// Replicas is the most recently oberved number of replicas.
|
||||
// Replicas is the most recently observed number of replicas.
|
||||
// More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller
|
||||
Replicas int32 `json:"replicas"`
|
||||
|
||||
|
|
|
@ -94,7 +94,7 @@ type FcosDownloadInfo struct {
|
|||
func (f FcosDownload) HasUsableCache() (bool, error) {
|
||||
// check the sha of the local image if it exists
|
||||
// get the sha of the remote image
|
||||
// == dont bother to pull
|
||||
// == do not bother to pull
|
||||
if _, err := os.Stat(f.LocalPath); os.IsNotExist(err) {
|
||||
return false, nil
|
||||
}
|
||||
|
|
|
@ -206,7 +206,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..
|
||||
// Maybe extracting then renaming is a good idea here..
|
||||
// depends on xz: not pre-installed on mac, so it becomes a brew dependency
|
||||
func decompressXZ(src string, output io.WriteCloser) error {
|
||||
var read io.Reader
|
||||
|
|
|
@ -218,7 +218,7 @@ func migrateVM(configPath string, config []byte, vm *MachineVM) error {
|
|||
}
|
||||
// Write the config file
|
||||
if err := vm.writeConfig(); err != nil {
|
||||
// If the config file fails to be written, put the origina
|
||||
// If the config file fails to be written, put the original
|
||||
// config file back before erroring
|
||||
if renameError := os.Rename(configPath+".orig", configPath); renameError != nil {
|
||||
logrus.Warn(renameError)
|
||||
|
@ -1390,7 +1390,7 @@ func (v *MachineVM) setPIDSocket() error {
|
|||
return nil
|
||||
}
|
||||
|
||||
// Deprecated: getSocketandPid is being replace by setPIDSocket and
|
||||
// Deprecated: getSocketandPid is being replaced by setPIDSocket and
|
||||
// machinefiles.
|
||||
func (v *MachineVM) getSocketandPid() (string, string, error) {
|
||||
rtPath, err := getRuntimeDir()
|
||||
|
|
|
@ -216,7 +216,7 @@ func reboot() error {
|
|||
if _, err := os.Lstat(filepath.Join(os.Getenv(localAppData), wtLocation)); err == nil {
|
||||
wtCommand := wtPrefix + command
|
||||
// RunOnce is limited to 260 chars (supposedly no longer in Builds >= 19489)
|
||||
// For now fallbacak in cases of long usernames (>89 chars)
|
||||
// For now fallback in cases of long usernames (>89 chars)
|
||||
if len(wtCommand) < 260 {
|
||||
command = wtCommand
|
||||
}
|
||||
|
|
|
@ -201,7 +201,7 @@ func MakeContainer(ctx context.Context, rt *libpod.Runtime, s *specgen.SpecGener
|
|||
}
|
||||
resources := runtimeSpec.Linux.Resources
|
||||
|
||||
// resources get overwrritten similarly to pod inheritance, manually assign here if there is a new value
|
||||
// resources get overwritten similarly to pod inheritance, manually assign here if there is a new value
|
||||
marshalRes, err := json.Marshal(resources)
|
||||
if err != nil {
|
||||
return nil, nil, nil, err
|
||||
|
|
|
@ -233,7 +233,7 @@ func namespaceOptions(s *specgen.SpecGenerator, rt *libpod.Runtime, pod *libpod.
|
|||
}
|
||||
|
||||
// This wipes the UserNS settings that get set from the infra container
|
||||
// when we are inheritting from the pod. So only apply this if the container
|
||||
// when we are inheriting from the pod. So only apply this if the container
|
||||
// is not being created in a pod.
|
||||
if s.IDMappings != nil {
|
||||
if pod == nil {
|
||||
|
|
|
@ -42,7 +42,7 @@ const (
|
|||
// None indicates the IPC namespace is created without mounting /dev/shm
|
||||
None NamespaceMode = "none"
|
||||
// NoNetwork indicates no network namespace should
|
||||
// be joined. loopback should still exists.
|
||||
// be joined. loopback should still exist.
|
||||
// Only used with the network namespace, invalid otherwise.
|
||||
NoNetwork NamespaceMode = "none"
|
||||
// Bridge indicates that a CNI network stack
|
||||
|
|
|
@ -229,7 +229,7 @@ func extractFirstWord(in string, separators string, flags SplitFlags) (string, s
|
|||
backslash := false // whether we've just seen a backslash
|
||||
|
||||
// The string handling in this function is a bit weird, using
|
||||
// 0 bytes to mark end-of-string. This is because its a direct
|
||||
// 0 bytes to mark end-of-string. This is because it is a direct
|
||||
// conversion of the C in systemd, and w want to ensure
|
||||
// exactly the same behaviour of some complex code
|
||||
|
||||
|
|
|
@ -733,7 +733,7 @@ func IDtoolsToRuntimeSpec(idMaps []idtools.IDMap) (convertedIDMap []specs.LinuxI
|
|||
}
|
||||
|
||||
func LookupUser(name string) (*user.User, error) {
|
||||
// Assume UID look up first, if it fails lookup by username
|
||||
// Assume UID lookup first, if it fails look up by username
|
||||
if u, err := user.LookupId(name); err == nil {
|
||||
return u, nil
|
||||
}
|
||||
|
|
|
@ -536,7 +536,7 @@ same containers would survive the logout and continue running.
|
|||
#### Solution
|
||||
|
||||
When systemd notes that a session that started a Podman container has exited,
|
||||
it will also stop any containers that has been associated with it. To avoid
|
||||
it will also stop any containers that have been associated with it. To avoid
|
||||
this, use the following command before logging out: `loginctl enable-linger`.
|
||||
To later revert the linger functionality, use `loginctl disable-linger`.
|
||||
|
||||
|
|
Loading…
Reference in a new issue