diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-03-10 21:57:04 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-10 21:57:04 +0100 |
| commit | fe49daa3c2e83bd0ec8ee36ec156b73967f4f0da (patch) | |
| tree | aab55239add80e612af4553382f744df1b793c85 | |
| parent | d083d6a8fc965a7eb42045a72f4685052860a2bd (diff) | |
| parent | 7534f9dd1a2e9ee4b7a7a7333ff2ec636949d68f (diff) | |
| download | podman-fe49daa3c2e83bd0ec8ee36ec156b73967f4f0da.tar.gz podman-fe49daa3c2e83bd0ec8ee36ec156b73967f4f0da.tar.bz2 podman-fe49daa3c2e83bd0ec8ee36ec156b73967f4f0da.zip | |
Merge pull request #5402 from vrothberg/syslog
docs: clarify bools in `podman --help`
| -rw-r--r-- | cmd/podman/main_local.go | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman.1.md | 6 |
2 files changed, 6 insertions, 5 deletions
diff --git a/cmd/podman/main_local.go b/cmd/podman/main_local.go index e5b87754b..79b5e5af7 100644 --- a/cmd/podman/main_local.go +++ b/cmd/podman/main_local.go @@ -67,10 +67,11 @@ 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)") + markFlagHidden(rootCmd.PersistentFlags(), "trace") } func setSyslog() error { 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** |