opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-07-04 10:10:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add disclaimer to podman machine info manpage.

Browse Source 
Adds a note in the `podman machine info` manpage that clarifies
that `defaultmachine` in the `podman machine info` output does
not suggest that a user can set a default podman machine via
system connections.

Additionally adds a Podman 6.0 TODO comment to change the name of the
field to `ActiveMachineConnection` to better describe its purpose.

[NO NEW TESTS NEEDED]

Signed-off-by: Jake Correnti <jakecorrenti+github@proton.me>
This commit is contained in:
Jake Correnti
2024-09-03 13:33:50 -04:00
parent efd4971545
commit 8eb7eff899
2 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/markdown/podman-machine-info.1.md
View File

@ -11,6 +11,12 @@ podman\-machine\-info - Display machine host info
Display information pertaining to the machine host.
Rootless only, as all `podman machine` commands can be only be used with rootless Podman.
*Note*: The `DefaultMachine` field in the `Host` output does not suggest that
one can set a default podman machine via system connections. This value represents
the current active system connection associated with a podman machine. Regardless
of the default system connection, the default podman machine will always be
`podman-machine-default`.
## OPTIONS
#### **--format**, **-f**=*format*

10
pkg/domain/entities/machine.go
View File

@ -28,8 +28,14 @@ type MachineInfo struct {
// MachineHostInfo contains info on the machine host
type MachineHostInfo struct {
Arch string `json:"Arch"`
CurrentMachine string `json:"CurrentMachine"`
Arch string `json:"Arch"`
CurrentMachine string `json:"CurrentMachine"`
// TODO(6.0): Change `DefaultName` to `ActiveMachineConnection` to fix address
// confusion as shown in https://github.com/containers/podman/issues/23353.
// The name `DefaultMachine` can cause confusion with the user in thinking that
// they can set a default podman machine via system connections. However,
// regardless of which system connection is default, the default podman machine
// will always be podman-machine-default.
DefaultMachine string `json:"DefaultMachine"`
EventsDir string `json:"EventsDir"`
MachineConfigDir string `json:"MachineConfigDir"`