diff options
| author | Naoaki Ueda <nao@uedder.com> | 2022-10-10 15:40:33 +0900 |
|---|---|---|
| committer | Naoaki Ueda <nao@uedder.com> | 2022-10-10 16:14:59 +0900 |
| commit | a52f2c0c1ad9b5d5153c70fb8c700bd6a619f2e9 (patch) | |
| tree | 9d2c8f389b00ebe10ab2d2455cd0d5b6c2ea37c7 | |
| parent | 5908996738daf0fe7463f21d58affc60d279466b (diff) | |
| download | podman-a52f2c0c1ad9b5d5153c70fb8c700bd6a619f2e9.tar.gz podman-a52f2c0c1ad9b5d5153c70fb8c700bd6a619f2e9.tar.bz2 podman-a52f2c0c1ad9b5d5153c70fb8c700bd6a619f2e9.zip | |
Man pages: Add mention of behavior due to XDG_CONFIG_HOMEpr-16099-first-reviewed
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
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..91b4177ca 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. Therefore, if you change the +`$XDG_CONFIG_HOME` environment variable, the output of the `podman machine list` will also be changed. +(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..f4bccf8fc 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 configurations for the virtual machines are managed under the +`$XDG_CONFIG_HOME/containers/podman/machine/` directory. If you change the `$XDG_CONFIG_HOME` +environment variable while the virtual machine runs, unexpected behavior could occur. + ## SUBCOMMANDS | Command | Man Page | Description | |