Skip to content

Minor fixes to --help and README #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 30, 2020
Merged

Minor fixes to --help and README #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0152a7b
cli: Set non-empty Usage Attribute
rhafer Oct 30, 2020
bc547fa
Add note about how to specify multiple modules
rhafer Oct 30, 2020
5deb2df
Refresh --help output in README.md
rhafer Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ all available commands and indicates which one is the current default:
```
container-suseconnect -h
NAME:
container-suseconnect
container-suseconnect - Access zypper repositories from within containers

USAGE:
This application can be used to retrieve basic metadata about SLES
Expand All @@ -28,26 +28,27 @@ USAGE:

Use the 'list-modules' subcommand for listing available modules, where
their 'Identifier' can be used to enable them via the ADDITIONAL_MODULES
environment variable during container creation/run.
environment variable during container creation/run. When enabling multiple
modules the identifiers are expected to be comma-separated.

The 'zypper' subcommand runs the application as zypper plugin and is only
intended to use for debugging purposes.

VERSION:
2.1.0
2.3.0

COMMANDS:
list-products, lp List available products (default)
list-modules, lm List available modules
zypper, z, zypp Run the zypper service plugin
help, h Shows a list of commands or help for one command
list-products, lp List available products (default)
list-modules, lm List available modules
zypper, z, zypp Run the zypper service plugin
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
--help, -h show help (default: false)
--version, -v print the version (default: false)

COPYRIGHT:
© 2018 SUSE LCC
© 2020 SUSE LCC
```

## Logging
Expand Down Expand Up @@ -117,7 +118,8 @@ RUN zypper -n in vim

All recommended package modules are enabled by default. It is possible to enable
additionally non-recommended modules via the `identifier` by setting the
environment variable `ADDITIONAL_MODULES`:
environment variable `ADDITIONAL_MODULES`. When enabling multiple modules the
identifiers are expected to be comma-separated:

```
FROM registry.suse.com/suse/sle15:latest
Expand Down
5 changes: 3 additions & 2 deletions cmd/container-suseconnect/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ func main() {
app.Copyright = fmt.Sprintf("© %d SUSE LCC", time.Now().Year())
app.Name = "container-suseconnect"
app.Version = cs.Version
app.Usage = ""
app.Usage = "Access zypper repositories from within containers"
app.UsageText =
`This application can be used to retrieve basic metadata about SLES
related products and module extensions.
Expand All @@ -44,7 +44,8 @@ func main() {

Use the 'list-modules' subcommand for listing available modules, where
their 'Identifier' can be used to enable them via the ADDITIONAL_MODULES
environment variable during container creation/run.
environment variable during container creation/run. When enabling multiple
modules the identifiers are expected to be comma-separated.

The 'zypper' subcommand runs the application as zypper plugin and is only
intended to use for debugging purposes.`
Expand Down