From 1be9959cf55692f9f067f598c0ff31d1bd4c3e38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Wei=C3=9Fe?= Date: Wed, 10 Jul 2024 09:00:56 +0200 Subject: [PATCH] Update CLI doc strings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Daniel Weiße --- internal/api/attestationconfigapi/cli/compare.go | 6 +++--- internal/api/attestationconfigapi/cli/delete.go | 2 +- internal/api/attestationconfigapi/cli/upload.go | 2 +- internal/api/attestationconfigapi/cli/validargs.go | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/internal/api/attestationconfigapi/cli/compare.go b/internal/api/attestationconfigapi/cli/compare.go index 2e77b2578..11faa94eb 100644 --- a/internal/api/attestationconfigapi/cli/compare.go +++ b/internal/api/attestationconfigapi/cli/compare.go @@ -21,9 +21,9 @@ import ( func newCompareCmd() *cobra.Command { cmd := &cobra.Command{ - Use: "compare {aws-sev-snp|azure-sev-snp|azure-tdx|gcp-sev-snp} [FILE] [FILE] ...", - Short: "Compare two or more attestation reports and return the lowest version", - Long: "Compare two or more attestation reports and return the lowest version.", + Use: "compare VARIANT FILE FILE [FILE...]", + Short: "Returns the minimum version of all given attestation reports.", + Long: "Compare two or more attestation reports and return the report with the minimum version of all given attestation reports.", Example: "cli compare azure-sev-snp report1.json report2.json", Args: cobra.MatchAll(cobra.MinimumNArgs(3), arg0isAttestationVariant()), RunE: runCompare, diff --git a/internal/api/attestationconfigapi/cli/delete.go b/internal/api/attestationconfigapi/cli/delete.go index 4d680e561..a800f7e80 100644 --- a/internal/api/attestationconfigapi/cli/delete.go +++ b/internal/api/attestationconfigapi/cli/delete.go @@ -26,7 +26,7 @@ import ( // newDeleteCmd creates the delete command. func newDeleteCmd() *cobra.Command { cmd := &cobra.Command{ - Use: "delete {aws-sev-snp|azure-sev-snp|azure-tdx|gcp-sev-snp} {attestation-report|guest-firmware} ", + Use: "delete VARIANT KIND ", Short: "Delete an object from the attestationconfig API", Long: "Delete a specific object version from the config api. is the name of the object to delete (without .json suffix)", Example: "COSIGN_PASSWORD=$CPW COSIGN_PRIVATE_KEY=$CKEY cli delete azure-sev-snp attestation-report 1.0.0", diff --git a/internal/api/attestationconfigapi/cli/upload.go b/internal/api/attestationconfigapi/cli/upload.go index fbe17ed9f..4032f4626 100644 --- a/internal/api/attestationconfigapi/cli/upload.go +++ b/internal/api/attestationconfigapi/cli/upload.go @@ -29,7 +29,7 @@ import ( func newUploadCmd() *cobra.Command { uploadCmd := &cobra.Command{ - Use: "upload {aws-sev-snp|azure-sev-snp|azure-tdx|gcp-sev-snp} {attestation-report|guest-firmware} ", + Use: "upload VARIANT KIND FILE", Short: "Upload an object to the attestationconfig API", Long: fmt.Sprintf("Upload a new object to the attestationconfig API. For snp-reports the new object is added to a cache folder first.\n"+ diff --git a/internal/api/attestationconfigapi/cli/validargs.go b/internal/api/attestationconfigapi/cli/validargs.go index b4289e448..b5366b0f9 100644 --- a/internal/api/attestationconfigapi/cli/validargs.go +++ b/internal/api/attestationconfigapi/cli/validargs.go @@ -33,7 +33,7 @@ func arg0isAttestationVariant() cobra.PositionalArgs { func isValidKind(arg int) cobra.PositionalArgs { return func(_ *cobra.Command, args []string) error { if kind := kindFromString(args[arg]); kind == unknown { - return fmt.Errorf("argument %s isn't a valid kind", args[arg]) + return fmt.Errorf("argument %s isn't a valid kind: must be one of [%q, %q]", args[arg], attestationReport, guestFirmware) } return nil }