From d5e52bc2cecc8a9735eb30d5620847076ebdde1a Mon Sep 17 00:00:00 2001 From: Christopher Angelo Phillips <32073428+spiffcs@users.noreply.github.com> Date: Wed, 29 Jan 2025 10:47:04 -0500 Subject: [PATCH] docs: update descriptions with correct options (#3630) Signed-off-by: Christopher Phillips <32073428+spiffcs@users.noreply.github.com> --- cmd/syft/internal/options/pkg.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/syft/internal/options/pkg.go b/cmd/syft/internal/options/pkg.go index b15104d9938..14ea6888241 100644 --- a/cmd/syft/internal/options/pkg.go +++ b/cmd/syft/internal/options/pkg.go @@ -16,9 +16,9 @@ var _ interface { } = (*packageConfig)(nil) func (o *packageConfig) DescribeFields(descriptions clio.FieldDescriptionSet) { - descriptions.Add(&o.SearchUnindexedArchives, `search within archives that do contain a file index to search against (zip) + descriptions.Add(&o.SearchIndexedArchives, `search within archives that do contain a file index to search against (zip) note: for now this only applies to the java package cataloger`) - descriptions.Add(&o.SearchIndexedArchives, `search within archives that do not contain a file index to search against (tar, tar.gz, tar.bz2, etc) + descriptions.Add(&o.SearchUnindexedArchives, `search within archives that do not contain a file index to search against (tar, tar.gz, tar.bz2, etc) note: enabling this may result in a performance impact since all discovered compressed tars will be decompressed note: for now this only applies to the java package cataloger`) descriptions.Add(&o.ExcludeBinaryOverlapByOwnership, `allows users to exclude synthetic binary packages from the sbom