Skip to content

Commit

Permalink
update help text
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Goodman <[email protected]>
  • Loading branch information
wagoodman committed Nov 12, 2024
1 parent f33bdb5 commit dad17f4
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion cmd/syft/internal/options/file.go
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
- "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)`)
Expand Down

0 comments on commit dad17f4

Please sign in to comment.