diff options
| author | Naoaki Ueda <nao@uedder.com> | 2022-10-10 15:40:33 +0900 |
|---|---|---|
| committer | Naoaki Ueda <nao@uedder.com> | 2022-10-10 22:24:09 +0900 |
| commit | d4052c1aa9a88488a163397caa0c61147ca98225 (patch) | |
| tree | 6c717f20f3b9baad01a846ff06575305321718a9 | |
| parent | 5908996738daf0fe7463f21d58affc60d279466b (diff) | |
| download | podman-d4052c1aa9a88488a163397caa0c61147ca98225.tar.gz podman-d4052c1aa9a88488a163397caa0c61147ca98225.tar.bz2 podman-d4052c1aa9a88488a163397caa0c61147ca98225.zip | |
Man pages: Add mention of behavior due to XDG_CONFIG_HOMEupdate-docs-for-podman-machine
When the `XDG_CONFIG_HOME` environment variable is changed, for example,
to switch development contexts, the behavior of the podman-machine can
be confusing. The documentation had not mentioned this, and this commit
adds these mentions.
Closes: https://github.com/containers/podman/issues/15577
Reviewed-by: Daniel J Walsh <dwalsh@redhat.com>
Signed-off-by: Naoaki Ueda <nao@uedder.com>
| -rw-r--r-- | docs/source/markdown/podman-machine-list.1.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-machine.1.md | 4 |
2 files changed, 9 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-machine-list.1.md b/docs/source/markdown/podman-machine-list.1.md index 0c929dcdc..bb1096697 100644 --- a/docs/source/markdown/podman-machine-list.1.md +++ b/docs/source/markdown/podman-machine-list.1.md @@ -19,6 +19,11 @@ but can be optionally used on Linux. Rootless only. +NOTE: The podman-machine configuration file is managed under the +`$XDG_CONFIG_HOME/containers/podman/machine/` directory. Changing the `$XDG_CONFIG_HOME` +environment variable while the machines are running can lead to unexpected behavior. +(see [podman(1)](podman.1.md)) + ## OPTIONS #### **--format**=*format* diff --git a/docs/source/markdown/podman-machine.1.md b/docs/source/markdown/podman-machine.1.md index a3d04c776..37b864c36 100644 --- a/docs/source/markdown/podman-machine.1.md +++ b/docs/source/markdown/podman-machine.1.md @@ -16,6 +16,10 @@ but can be optionally used on Linux. All `podman machine` commands are rootless only. +NOTE: The podman-machine configuration file is managed under the +`$XDG_CONFIG_HOME/containers/podman/machine/` directory. Changing the `$XDG_CONFIG_HOME` +environment variable while the machines are running can lead to unexpected behavior. + ## SUBCOMMANDS | Command | Man Page | Description | |