Merge pull request #16099 from na0x2c6/update-docs-for-podman-machine

[CI:DOCS] Man pages: Add mention of behavior due to XDG_CONFIG_HOME
containers · Oct 12, 2022 · 1db0735 · 1db0735
2 parents e5ace19 + d4052c1
commit 1db0735
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git 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
@@ -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                       |