2020-12-01 13:37:26 -08:00
|
|
|
#[===[
|
|
|
|
# vcpkg_add_to_path
|
|
|
|
|
2021-02-17 10:08:50 -08:00
|
|
|
Add a directory or directories to the PATH environment variable
|
2020-12-01 13:37:26 -08:00
|
|
|
|
|
|
|
```cmake
|
2021-02-17 10:08:50 -08:00
|
|
|
vcpkg_add_to_path([PREPEND] [<path>...])
|
2020-12-01 13:37:26 -08:00
|
|
|
```
|
|
|
|
|
2021-02-17 10:08:50 -08:00
|
|
|
`vcpkg_add_to_path` adds all of the paths passed to it to the PATH environment variable.
|
|
|
|
If PREPEND is passed, then those paths are prepended to the PATH environment variable,
|
|
|
|
so that they are searched first; otherwise, those paths are appended, so they are
|
|
|
|
searched after the paths which are already in the environment variable.
|
2020-12-01 13:37:26 -08:00
|
|
|
|
2021-02-17 10:08:50 -08:00
|
|
|
The paths are added in the order received, so that the first path is always searched
|
|
|
|
before a later path.
|
2020-12-01 13:37:26 -08:00
|
|
|
|
2021-02-17 10:08:50 -08:00
|
|
|
If no paths are passed, then nothing will be done.
|
2020-12-01 13:37:26 -08:00
|
|
|
|
|
|
|
## Examples:
|
|
|
|
* [curl](https://github.com/Microsoft/vcpkg/blob/master/ports/curl/portfile.cmake#L75)
|
|
|
|
* [folly](https://github.com/Microsoft/vcpkg/blob/master/ports/folly/portfile.cmake#L15)
|
|
|
|
* [z3](https://github.com/Microsoft/vcpkg/blob/master/ports/z3/portfile.cmake#L13)
|
|
|
|
#]===]
|
2018-08-13 16:07:26 -07:00
|
|
|
function(vcpkg_add_to_path)
|
2021-02-17 10:08:50 -08:00
|
|
|
cmake_parse_arguments(PARSE_ARGV 0 "arg" "PREPEND" "" "")
|
|
|
|
if(arg_PREPEND)
|
2021-09-27 13:27:44 -07:00
|
|
|
set(operation PREPEND)
|
2018-08-13 16:07:26 -07:00
|
|
|
else()
|
2021-09-27 13:27:44 -07:00
|
|
|
set(operation APPEND)
|
2018-08-13 16:07:26 -07:00
|
|
|
endif()
|
2021-09-27 13:27:44 -07:00
|
|
|
|
|
|
|
vcpkg_host_path_list("${operation}" ENV{PATH} ${arg_UNPARSED_ARGUMENTS})
|
2020-12-01 13:37:26 -08:00
|
|
|
endfunction()
|