diff --git a/docs/docker_scout_compare.yaml b/docs/docker_scout_compare.yaml index 37e3649c..5737f117 100644 --- a/docs/docker_scout_compare.yaml +++ b/docs/docker_scout_compare.yaml @@ -99,8 +99,7 @@ options: - option: ignore-suppressed value_type: bool default_value: "false" - description: | - Filter CVEs found in Scout exceptions based on the specified exception scope + description: Filter out CVEs suppressed by a Scout exception deprecated: false hidden: false experimental: false diff --git a/docs/docker_scout_cves.yaml b/docs/docker_scout_cves.yaml index d7bd9bca..a19d3c28 100644 --- a/docs/docker_scout_cves.yaml +++ b/docs/docker_scout_cves.yaml @@ -127,8 +127,7 @@ options: - option: ignore-suppressed value_type: bool default_value: "false" - description: | - Filter CVEs found in Scout exceptions based on the specified exception scope + description: Filter out CVEs suppressed by a Scout exception deprecated: false hidden: false experimental: false diff --git a/docs/docker_scout_quickview.yaml b/docs/docker_scout_quickview.yaml index 8932e136..b38f7f18 100644 --- a/docs/docker_scout_quickview.yaml +++ b/docs/docker_scout_quickview.yaml @@ -49,8 +49,7 @@ options: - option: ignore-suppressed value_type: bool default_value: "false" - description: | - Filter CVEs found in Scout exceptions based on the specified exception scope + description: Filter out CVEs suppressed by a Scout exception deprecated: false hidden: false experimental: false diff --git a/docs/docker_scout_vex.yaml b/docs/docker_scout_vex.yaml index f6e9444a..b3ec343f 100644 --- a/docs/docker_scout_vex.yaml +++ b/docs/docker_scout_vex.yaml @@ -1,5 +1,4 @@ command: docker scout vex -aliases: docker scout vex, docker scout vex short: Manage VEX attestations on images long: Manage VEX attestations on images pname: docker scout diff --git a/docs/scout_compare.md b/docs/scout_compare.md index 9519b04a..83df040a 100644 --- a/docs/scout_compare.md +++ b/docs/scout_compare.md @@ -15,7 +15,7 @@ Compare two images and display differences (experimental) | `--format` | `string` | `text` | Output format of the generated vulnerability report:
- text: default output, plain text with or without colors depending on the terminal
- markdown: Markdown output
- json: JSON output
| | `--hide-policies` | | | Hide policy status from the output | | `--ignore-base` | | | Filter out CVEs introduced from base image | -| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope | +| `--ignore-suppressed` | | | Filter out CVEs suppressed by a Scout exception | | `--ignore-unchanged` | | | Filter out unchanged packages | | `--multi-stage` | | | Show packages from multi-stage Docker builds | | `--only-fixed` | | | Filter to fixable CVEs | diff --git a/docs/scout_cves.md b/docs/scout_cves.md index e6fd689c..f2ed397f 100644 --- a/docs/scout_cves.md +++ b/docs/scout_cves.md @@ -19,7 +19,7 @@ Display CVEs identified in a software artifact | `-e`, `--exit-code` | | | Return exit code '2' if vulnerabilities are detected | | `--format` | `string` | `packages` | Output format of the generated vulnerability report:
- packages: default output, plain text with vulnerabilities grouped by packages
- sarif: json Sarif output
- spdx: json SPDX output
- gitlab: json GitLab output
- markdown: markdown output (including some html tags like collapsible sections)
- sbom: json SBOM output
| | `--ignore-base` | | | Filter out CVEs introduced from base image | -| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope | +| `--ignore-suppressed` | | | Filter out CVEs suppressed by a Scout exception | | `--locations` | | | Print package locations including file paths and layer diff_id | | `--multi-stage` | | | Show packages from multi-stage Docker builds | | `--only-base` | | | Only show CVEs introduced by the base image | diff --git a/docs/scout_quickview.md b/docs/scout_quickview.md index e93828a0..47496246 100644 --- a/docs/scout_quickview.md +++ b/docs/scout_quickview.md @@ -12,7 +12,7 @@ Quick overview of an image | Name | Type | Default | Description | |:----------------------|:--------------|:--------------------|:--------------------------------------------------------------------------------------------------------| | `--env` | `string` | | Name of the environment | -| `--ignore-suppressed` | | | Filter CVEs found in Scout exceptions based on the specified exception scope | +| `--ignore-suppressed` | | | Filter out CVEs suppressed by a Scout exception | | `--latest` | | | Latest indexed image | | `--only-policy` | `stringSlice` | | Comma separated list of policies to evaluate | | `--only-vex-affected` | | | Filter CVEs by VEX statements with status not affected | diff --git a/docs/scout_vex.md b/docs/scout_vex.md index 4ac3db07..95faa47a 100644 --- a/docs/scout_vex.md +++ b/docs/scout_vex.md @@ -3,10 +3,6 @@ Manage VEX attestations on images -### Aliases - -`docker scout vex`, `docker scout vex` - ### Subcommands | Name | Description |