From 427a8934687ef9c2905a07977eec8827a7164e66 Mon Sep 17 00:00:00 2001 From: Alex Goodman Date: Tue, 12 Nov 2024 10:09:26 -0500 Subject: [PATCH] update help text Signed-off-by: Alex Goodman --- cmd/syft/internal/options/file.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/cmd/syft/internal/options/file.go b/cmd/syft/internal/options/file.go index 18fa7d86d2d..b4830f86712 100644 --- a/cmd/syft/internal/options/file.go +++ b/cmd/syft/internal/options/file.go @@ -66,11 +66,12 @@ func (c *fileConfig) PostLoad() error { } func (c *fileConfig) DescribeFields(descriptions clio.FieldDescriptionSet) { + descriptions.Add(&c.Enabled, `enable or disable file cataloging entirely`) descriptions.Add(&c.Metadata.Selection, `select which files should be captured by the file-metadata cataloger and included in the SBOM. Options include: - - "all": capture all files from the search space - - "owned-by-package": capture only files owned by packages - - "none", "": do not capture any files`) + - "all": capture metadata for all files from the search space + - "owned-by-package": capture metadata only for files owned by packages + - "none", "": do not capture metadata for any files`) descriptions.Add(&c.Metadata.Digests, `the file digest algorithms to use when cataloging files (options: "md5", "sha1", "sha224", "sha256", "sha384", "sha512")`) descriptions.Add(&c.Content.SkipFilesAboveSize, `skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes)`)