Skip to content

Commit

Permalink
Create vcpkg.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ras0219-msft committed Jul 8, 2024
1 parent fb9423e commit 75f88af
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/detectors/vcpkg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# vcpkg Detection

## Requirements

vcpkg detection triggers off of `vcpkg.spdx.json` files found under the scan directory.

## Detection strategy

The vcpkg detector searches for `vcpkg.spdx.json` files produced by vcpkg during the install process. These files are typically found
under the installed packages directory in a path like `installed/<triplet>/share/<port>/vcpkg.spdx.json`. Each vcpkg port installes a
separate `vcpkg.spdx.json` file[1].

Because this detection strategy looks for the concrete files in the installed tree, it will accurately detect the precise packages used
during this build and exclude packages optionally used on other platforms.

## Known limitations

The vcpkg detector does not distinguish between direct dependencies and transitive dependencies. It also does not distinguish
"development-only" dependencies that are not intended to impact the final shipping product.

[1]: https://learn.microsoft.com/vcpkg/reference/software-bill-of-materials

0 comments on commit 75f88af

Please sign in to comment.