diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainers/vcpkg_buildpath_length_warning.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/maintainers/vcpkg_buildpath_length_warning.md b/docs/maintainers/vcpkg_buildpath_length_warning.md index 77c1776b2..fdc7adeda 100644 --- a/docs/maintainers/vcpkg_buildpath_length_warning.md +++ b/docs/maintainers/vcpkg_buildpath_length_warning.md @@ -2,10 +2,13 @@ Warns the user if their vcpkg installation path might be too long for the package they're installing. -## Usage ```cmake -vcpkg_buildpath_length_warning(13) +vcpkg_buildpath_length_warning(<N>) ``` +`vcpkg_buildpath_length_warning` warns the user if the number of bytes in the +path to `buildtrees` is bigger than `N`. Note that this is simply a warning, +and isn't relied on for correctness. + ## Source [scripts/cmake/vcpkg_buildpath_length_warning.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_buildpath_length_warning.cmake) |