Skip to content

opm render: update help text to mention that output is a stream to stdout #1056

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 1 commit into from
Mar 7, 2023
Merged

opm render: update help text to mention that output is a stream to stdout #1056

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions cmd/opm/render/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ func NewCmd() *cobra.Command {
)
cmd := &cobra.Command{
Use: "render [index-image | bundle-image | sqlite-file]...",
Short: "Generate a declarative config blob from catalogs and bundles",
Long: `Generate a declarative config blob from the provided index images, bundle images, and sqlite database files
Short: "Generate a stream of file-based catalog objects from catalogs and bundles",
Long: `Generate a stream of file-based catalog objects to stdout from the provided
catalog images, file-based catalog directories, bundle images, and sqlite
database files.

` + sqlite.DeprecationMessage,
Args: cobra.MinimumNArgs(1),
Expand Down Expand Up @@ -63,7 +65,7 @@ func NewCmd() *cobra.Command {
}
},
}
cmd.Flags().StringVarP(&output, "output", "o", "json", "Output format (json|yaml)")
cmd.Flags().StringVarP(&output, "output", "o", "json", "Output format of the streamed file-based catalog objects (json|yaml)")
return cmd
}

Expand Down