style(help): Clarified support for Windows Docker images (related to
# Docker image support
-On Linux and Mac, ${solution_name} can invoke Docker Inspector to inspect Docker images. For simple use cases, add either ```--detect.docker.image={repo}:{tag}``` or ```--detect.docker.tar={path to a Docker saved tarfile}``` to the ${solution_name} command line.
+On Linux and Mac, ${solution_name} can invoke Docker Inspector to inspect Linux Docker images to discover packages installed by the Linux package manager.
+For simple use cases, add either ```--detect.docker.image={repo}:{tag}``` or ```--detect.docker.tar={path to a Docker saved tarfile}``` to the ${solution_name} command line.
The documentation for Docker Inspector is available [here](https://blackducksoftware.github.io/blackduck-docker-inspector/latest/overview/).
-When passed a value for either detect.docker.image or detect.docker.tar, ${solution_name} runs Docker Inspector on the given image; in other words, the target image, creating one code location. ${solution_name} by default runs the ${blackduck_signature_scanner_name} on the image. This is actually the file system a container created from the image has at startup time; refer to [${solution_name}'s scan target](#scantarget) for more details. This creates a second code location.
+When passed a value for either detect.docker.image or detect.docker.tar,
+${solution_name} runs Docker Inspector on given image (the "target image"),
+creating one code location. ${solution_name} by default runs
+the ${blackduck_signature_scanner_name} on the "container file system"
+(the file system a container created from the image has at startup time).
+Refer to [${solution_name}'s scan target](#scantarget) for more details.
+This creates a second code location.
### Passing Docker Inspector property values to Docker Inspector from ${solution_name}
@@ -50,3 +57,18 @@ Set the value of the Docker Inspector property docker.platform.top.layer.id to t
./detect.sh ... --detect.docker.image={your application image} --detect.docker.platform.top.layer.id=sha256:b079b3fa8d1b4b30a71a6e81763ed3da1327abaf0680ed3ed9f00ad1d5de5e7c
In this mode, there may be some loss in match accuracy from the ${blackduck_signature_scanner_name} because, in this scenario, the ${blackduck_signature_scanner_name} may be deprived of some contextual information, such as the operating system files that enable it to determine the Linux distribution, and that that may negatively affect its ability to accurately identify components.
+
+### Inspecting Windows images
+
+The Docker Inspector only runs on Linux and Mac. Running on these systems,
+Docker can neither pull nor build a Windows image.
+Consequently, you cannot run ${solution_name} on a Windows Docker image
+using the either the *detect.docker.image* or *detect.docker.image.id* property.
+Instead, you must, using a Windows system,
+pull and save the target image as a .tar file, and pass that .tar file
+to ${solution_name} using the *detect.docker.tar* property.
+
+Given a Windows Image, Docker Inspector, since it can only discover packages using
+a Linux package manager will not contribute any components to the BOM, but will
+return the container filesystem (in the form of a squashed image),
+which ${solution_name} will scan.
\ No newline at end of file
