From c3ef5d181bc47d13e1c329a54925e7342ddfb8ea Mon Sep 17 00:00:00 2001 From: nicole mazzuca Date: Wed, 17 Feb 2021 10:08:50 -0800 Subject: [scripts-audit] vcpkg_add_to_path (#16189) * [scripts-audit] vcpkg_add_to_path * regenerate docs --- docs/maintainers/vcpkg_add_to_path.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/maintainers/vcpkg_add_to_path.md b/docs/maintainers/vcpkg_add_to_path.md index af1727821..243757638 100644 --- a/docs/maintainers/vcpkg_add_to_path.md +++ b/docs/maintainers/vcpkg_add_to_path.md @@ -1,20 +1,20 @@ # vcpkg_add_to_path -Add a directory to the PATH environment variable +Add a directory or directories to the PATH environment variable -## Usage ```cmake -vcpkg_add_to_path([PREPEND] <${PYTHON3_DIR}>) +vcpkg_add_to_path([PREPEND] [...]) ``` -## Parameters -### -The directory to add +`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. -### PREPEND -Prepends the directory. +The paths are added in the order received, so that the first path is always searched +before a later path. -The default is to append. +If no paths are passed, then nothing will be done. ## Examples: * [curl](https://github.com/Microsoft/vcpkg/blob/master/ports/curl/portfile.cmake#L75) -- cgit v1.2.3