From ae5cbf37cf4c2b9aca8d3dfa27275419c7abc732 Mon Sep 17 00:00:00 2001 From: Daniel Rudolf Date: Mon, 15 May 2023 17:47:40 +0200 Subject: [PATCH] Fix documentation of `--network-cmd-path` CLI option The `--network-cmd-path` CLI option only affects rootless networks using `slirp4netns(1)`, not `pasta(1)`. Following #18568 Podman should rather use the more generic `r.config.FindHelperBinary()` method (and therefore honour the `helper_binaries_dir` config) to find the path to the `slirp4netns` binary and deprecate the misleading `--network-cmd-path` CLI option. However, since this wasn't implemented yet we can't deprecate `--network-cmd-path` as of now. Adding a note anyway. Fixes #18560 Signed-off-by: Daniel Rudolf --- cmd/podman/root.go | 1 + docs/source/markdown/podman.1.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/cmd/podman/root.go b/cmd/podman/root.go index cc440ca8f1..726bd119e5 100644 --- a/cmd/podman/root.go +++ b/cmd/podman/root.go @@ -438,6 +438,7 @@ func rootFlags(cmd *cobra.Command, podmanConfig *entities.PodmanConfig) { pFlags.StringVar(&podmanConfig.ConmonPath, conmonFlagName, "", "Path of the conmon binary") _ = cmd.RegisterFlagCompletionFunc(conmonFlagName, completion.AutocompleteDefault) + // TODO (5.0): remove this option with the next major release after https://github.com/containers/podman/issues/18560 was implemented networkCmdPathFlagName := "network-cmd-path" pFlags.StringVar(&podmanConfig.ContainersConf.Engine.NetworkCmdPath, networkCmdPathFlagName, podmanConfig.ContainersConfDefaultsRO.Engine.NetworkCmdPath, "Path to the command for configuring the network") _ = cmd.RegisterFlagCompletionFunc(networkCmdPathFlagName, completion.AutocompleteDefault) diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 924ef13d8d..d34a4e68d2 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -83,7 +83,7 @@ Remote connections use local containers.conf for default. Log messages at and above specified level: debug, info, warn, error, fatal or panic (default: "warn") #### **--network-cmd-path**=*path* -Path to the command binary to use for setting up a network. It is currently only used for setting up a slirp4netns(1) or pasta(1) network. If "" is used then the binary is looked up using the $PATH environment variable. +Path to the `slirp4netns(1)` command binary to use for setting up a slirp4netns network. If "" is used then the binary is looked up using the $PATH environment variable. #### **--network-config-dir**=*directory*