From 49b70946bcbe9c997fd523b0ecb0ea57a85fd7fa Mon Sep 17 00:00:00 2001 From: Valentin Rothberg Date: Thu, 5 Mar 2020 15:07:19 +0100 Subject: docs: clarify that --syslog expects an argument Clarify in the man page that --syslog expexts an argument to prevent users from believing it's a switch. Signed-off-by: Valentin Rothberg --- docs/source/markdown/podman.1.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index 853b5ecec..86d246e87 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -104,11 +104,11 @@ specify additional options via the `--storage-opt` flag. Storage driver option, Default storage driver options are configured in /etc/containers/storage.conf (`$HOME/.config/containers/storage.conf` in rootless mode). The `STORAGE_OPTS` environment variable overrides the default. The --storage-opt specified options overrides all. -**--syslog** +**--syslog**=*true|false* -Output logging information to syslog as well as the console. +Output logging information to syslog as well as the console (default *false*). -On remote clients, logging is directed to the file $HOME/.config/containers/podman.log +On remote clients, logging is directed to the file $HOME/.config/containers/podman.log. **--tmpdir** -- cgit v1.2.3-54-g00ecf From 7b10b71445a25d349cc64b5a561bca2860bde9b2 Mon Sep 17 00:00:00 2001 From: Valentin Rothberg Date: Thu, 5 Mar 2020 15:18:48 +0100 Subject: podman --help: mention defaults of bools While string variables are shown to expect a string argument, boolean variables are not. This easily tricks users into believing they are simple switches without arguments. Hence, explicitly mention the default to clarify it a bit more. Signed-off-by: Valentin Rothberg --- cmd/podman/main_local.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/podman/main_local.go b/cmd/podman/main_local.go index e5b87754b..9af698d95 100644 --- a/cmd/podman/main_local.go +++ b/cmd/podman/main_local.go @@ -67,10 +67,10 @@ func init() { // -s is deprecated due to conflict with -s on subcommands rootCmd.PersistentFlags().StringVar(&MainGlobalOpts.StorageDriver, "storage-driver", "", "Select which storage driver is used to manage storage of images and containers (default is overlay)") rootCmd.PersistentFlags().StringArrayVar(&MainGlobalOpts.StorageOpts, "storage-opt", []string{}, "Used to pass an option to the storage driver") - rootCmd.PersistentFlags().BoolVar(&MainGlobalOpts.Syslog, "syslog", false, "Output logging information to syslog as well as the console") + rootCmd.PersistentFlags().BoolVar(&MainGlobalOpts.Syslog, "syslog", false, "Output logging information to syslog as well as the console (default false)") rootCmd.PersistentFlags().StringVar(&MainGlobalOpts.TmpDir, "tmpdir", "", "Path to the tmp directory for libpod state content.\n\nNote: use the environment variable 'TMPDIR' to change the temporary storage location for container images, '/var/tmp'.\n") - rootCmd.PersistentFlags().BoolVar(&MainGlobalOpts.Trace, "trace", false, "Enable opentracing output") + rootCmd.PersistentFlags().BoolVar(&MainGlobalOpts.Trace, "trace", false, "Enable opentracing output (default false)") } func setSyslog() error { -- cgit v1.2.3-54-g00ecf From 7534f9dd1a2e9ee4b7a7a7333ff2ec636949d68f Mon Sep 17 00:00:00 2001 From: Valentin Rothberg Date: Tue, 10 Mar 2020 08:31:16 +0100 Subject: hide --trace flag The tracing flag is not really something users should worry about. Signed-off-by: Valentin Rothberg --- cmd/podman/main_local.go | 1 + 1 file changed, 1 insertion(+) diff --git a/cmd/podman/main_local.go b/cmd/podman/main_local.go index 9af698d95..79b5e5af7 100644 --- a/cmd/podman/main_local.go +++ b/cmd/podman/main_local.go @@ -71,6 +71,7 @@ func init() { rootCmd.PersistentFlags().StringVar(&MainGlobalOpts.TmpDir, "tmpdir", "", "Path to the tmp directory for libpod state content.\n\nNote: use the environment variable 'TMPDIR' to change the temporary storage location for container images, '/var/tmp'.\n") rootCmd.PersistentFlags().BoolVar(&MainGlobalOpts.Trace, "trace", false, "Enable opentracing output (default false)") + markFlagHidden(rootCmd.PersistentFlags(), "trace") } func setSyslog() error { -- cgit v1.2.3-54-g00ecf