From 68c4bf8bbe3d8556cfec4849b5b9d14cdead7b34 Mon Sep 17 00:00:00 2001 From: Alex Goodman Date: Tue, 23 Mar 2021 13:00:25 -0400 Subject: [PATCH] update documentation to reflect root vs packages subcommand Signed-off-by: Alex Goodman --- Makefile | 2 +- README.md | 8 +++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index ed2431803..ce2cd9843 100644 --- a/Makefile +++ b/Makefile @@ -78,7 +78,7 @@ all: clean static-analysis test ## Run all linux-based checks (linting, license @printf '$(SUCCESS)All checks pass!$(RESET)\n' .PHONY: test -test: unit validate-cyclonedx-schema integration benchmark acceptance-linux cli ## Run all tests (currently unit, integration, linux acceptance, and mac cli tests) +test: unit validate-cyclonedx-schema integration benchmark acceptance-linux cli ## Run all tests (currently unit, integration, linux acceptance, and cli tests) .PHONY: help help: diff --git a/README.md b/README.md index 47ba28c61..a16433c2d 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,14 @@ If you encounter an issue, please [let us know using the issue tracker](https:// To generate an SBOM for a Docker or OCI image: ``` -syft packages - -# note: this is the same as not providing the "packages" subcommand syft ``` +**Note**: This is equivalent to specifying the `packages` subcommand: +``` +syft packages +``` + The above output includes only software that is visible in the container (i.e., the squashed representation of the image). To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`: