vcpkg/docs/maintainers/vcpkg_buildpath_length_warning.md

# vcpkg_buildpath_length_warning

Warns the user if their vcpkg installation path might be too long for the package they're installing.

```cmake
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)
[vcpkg docs] Check for documentation generation in CI (#14614) * [vcpkg docs] Change how documenting port functions works Instead of using `##`, use comment blocks for documentation. Also, add some minor docs and change RST -> MD so we actually get docs generated. * add CI stuff * regenerate docs * fix vcpkg_find_acquire_program to not use _execute_process 2020-12-02 05:37:26 +08:00			`# vcpkg_buildpath_length_warning`

			`Warns the user if their vcpkg installation path might be too long for the package they're installing.`

			```cmake
[scripts-audit] vcpkg_buildpath_length_warning (#16191) 2021-02-16 04:26:56 +08:00			`vcpkg_buildpath_length_warning(<N>)`
[vcpkg docs] Check for documentation generation in CI (#14614) * [vcpkg docs] Change how documenting port functions works Instead of using `##`, use comment blocks for documentation. Also, add some minor docs and change RST -> MD so we actually get docs generated. * add CI stuff * regenerate docs * fix vcpkg_find_acquire_program to not use _execute_process 2020-12-02 05:37:26 +08:00			```

[scripts-audit] vcpkg_buildpath_length_warning (#16191) 2021-02-16 04:26:56 +08:00			`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.`

[vcpkg docs] Check for documentation generation in CI (#14614) * [vcpkg docs] Change how documenting port functions works Instead of using `##`, use comment blocks for documentation. Also, add some minor docs and change RST -> MD so we actually get docs generated. * add CI stuff * regenerate docs * fix vcpkg_find_acquire_program to not use _execute_process 2020-12-02 05:37:26 +08:00			`## Source`
[vcpkg docs] consistency-ify docs/regenerate on non-windows (#16127) 2021-02-09 05:55:11 +08:00			`[scripts/cmake/vcpkg_buildpath_length_warning.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_buildpath_length_warning.cmake)`