vcpkg/scripts/cmake/vcpkg_add_to_path.cmake

#[===[
# vcpkg_add_to_path

Add a directory or directories to the PATH environment variable

```cmake
vcpkg_add_to_path([PREPEND] [<path>...])
```

`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.

The paths are added in the order received, so that the first path is always searched
before a later path.

If no paths are passed, then nothing will be done.

## 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)
#]===]
function(vcpkg_add_to_path)
    cmake_parse_arguments(PARSE_ARGV 0 "arg" "PREPEND" "" "")
    if(arg_PREPEND)
        set(operation PREPEND)
    else()
        set(operation APPEND)
    endif()

    vcpkg_host_path_list("${operation}" ENV{PATH} ${arg_UNPARSED_ARGUMENTS})
endfunction()
[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_add_to_path`

[scripts-audit] vcpkg_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs 2021-02-18 02:08:50 +08:00			`Add a directory or directories to the PATH environment variable`
[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
			```cmake
[scripts-audit] vcpkg_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs 2021-02-18 02:08:50 +08:00			`vcpkg_add_to_path([PREPEND] [<path>...])`
[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_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs 2021-02-18 02: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.`
[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_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs 2021-02-18 02:08:50 +08:00			`The paths are added in the order received, so that the first path is always searched`
			`before a later path.`
[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_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs 2021-02-18 02:08:50 +08:00			`If no paths are passed, then nothing will be done.`
[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
			`## 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)`
			`#]===]`
[folly] Do not use -Werror 2018-08-14 07:07:26 +08:00			`function(vcpkg_add_to_path)`
[scripts-audit] vcpkg_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs 2021-02-18 02:08:50 +08:00			`cmake_parse_arguments(PARSE_ARGV 0 "arg" "PREPEND" "" "")`
			`if(arg_PREPEND)`
[scripts-audit] vcpkg_fixup_pkgconfig (#19658) * [scripts-audit] vcpkg_fixup_pkgconfig * Neumann-A CR, fix docs * vcpkg_fixup_pkgconfig bugs * fix group * moar fixing * be more clever around pkg_config_path * add `vcpkg_host_path_list` so that we can unit test * move stuff around a bit * fix bug in vcpkg_host_path_list.cmake * ras0219 CRs 2021-09-28 04:27:44 +08:00			`set(operation PREPEND)`
[folly] Do not use -Werror 2018-08-14 07:07:26 +08:00			`else()`
[scripts-audit] vcpkg_fixup_pkgconfig (#19658) * [scripts-audit] vcpkg_fixup_pkgconfig * Neumann-A CR, fix docs * vcpkg_fixup_pkgconfig bugs * fix group * moar fixing * be more clever around pkg_config_path * add `vcpkg_host_path_list` so that we can unit test * move stuff around a bit * fix bug in vcpkg_host_path_list.cmake * ras0219 CRs 2021-09-28 04:27:44 +08:00			`set(operation APPEND)`
[folly] Do not use -Werror 2018-08-14 07:07:26 +08:00			`endif()`
[scripts-audit] vcpkg_fixup_pkgconfig (#19658) * [scripts-audit] vcpkg_fixup_pkgconfig * Neumann-A CR, fix docs * vcpkg_fixup_pkgconfig bugs * fix group * moar fixing * be more clever around pkg_config_path * add `vcpkg_host_path_list` so that we can unit test * move stuff around a bit * fix bug in vcpkg_host_path_list.cmake * ras0219 CRs 2021-09-28 04:27:44 +08:00
			`vcpkg_host_path_list("${operation}" ENV{PATH} ${arg_UNPARSED_ARGUMENTS})`
[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			`endfunction()`