From 59139448c46193710d03f0fcb4333875105bd49b Mon Sep 17 00:00:00 2001 From: Patrick Zheng Date: Thu, 9 Feb 2023 14:10:06 +0800 Subject: [PATCH] chore: updating sign command descriptions to align with the spec Signed-off-by: Patrick Zheng --- cmd/notation/sign.go | 2 +- internal/cmd/flags.go | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/notation/sign.go b/cmd/notation/sign.go index 5d8ec3f35..b8fbb15c6 100644 --- a/cmd/notation/sign.go +++ b/cmd/notation/sign.go @@ -84,7 +84,7 @@ Example - Sign an OCI artifact and use OCI image manifest to store the signature opts.SecureFlagOpts.ApplyFlags(command.Flags()) cmd.SetPflagExpiry(command.Flags(), &opts.expiry) cmd.SetPflagPluginConfig(command.Flags(), &opts.pluginConfig) - command.Flags().StringVar(&opts.signatureManifest, "signature-manifest", signatureManifestArtifact, "manifest type for signatures. options: artifact, image") + command.Flags().StringVar(&opts.signatureManifest, "signature-manifest", signatureManifestArtifact, "manifest type for signature. options: \"artifact\", \"image\"") cmd.SetPflagUserMetadata(command.Flags(), &opts.userMetadata, cmd.PflagUserMetadataSignUsage) return command } diff --git a/internal/cmd/flags.go b/internal/cmd/flags.go index 45e086230..3e73e473b 100644 --- a/internal/cmd/flags.go +++ b/internal/cmd/flags.go @@ -23,7 +23,7 @@ var ( PflagSignatureFormat = &pflag.Flag{ Name: "signature-format", - Usage: "signature envelope format, options: 'jws', 'cose'", + Usage: "signature envelope format, options: \"jws\", \"cose\"", } SetPflagSignatureFormat = func(fs *pflag.FlagSet, p *string) { defaultSignatureFormat := envelope.JWS @@ -75,9 +75,9 @@ var ( Name: "user-metadata", Shorthand: "m", } - PflagUserMetadataSignUsage = "{key}={value} pairs that are added to the signature payload" + PflagUserMetadataSignUsage = "{key}={value} pairs that are added to the signature payload" PflagUserMetadataVerifyUsage = "user defined {key}={value} pairs that must be present in the signature for successful verification if provided" - SetPflagUserMetadata = func(fs *pflag.FlagSet, p *[]string, usage string) { + SetPflagUserMetadata = func(fs *pflag.FlagSet, p *[]string, usage string) { fs.StringArrayVarP(p, PflagUserMetadata.Name, PflagUserMetadata.Shorthand, nil, usage) } )