vcpkg/docs/maintainers/vcpkg_execute_in_download_mode.md
nicole mazzuca 6b117c9c7e
[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-01 13:37:26 -08:00

1.0 KiB

vcpkg_execute_in_download_mode

Execute a process even in download mode.

Usage

vcpkg_execute_in_download_mode(
    COMMAND <cmd> [<arguments>]
    [WORKING_DIRECTORY <dir>]
    [TIMEOUT <seconds>]
    [RESULT_VARIABLE <variable>]
    [OUTPUT_VARIABLE <variable>]
    [ERROR_VARIABLE <variable>]
    [INPUT_FILE <file>]
    [OUTPUT_FILE <file>]
    [ERROR_FILE <file>]
    [OUTPUT_QUIET]
    [ERROR_QUIET]
    [OUTPUT_STRIP_TRAILING_WHITESPACE]
    [ERROR_STRIP_TRAILING_WHITESPACE]
    [ENCODING <name>]
)

The signature of this function is identical to execute_process() except that it only accepts one COMMAND argument, i.e., does not support chaining multiple commands with pipes.

See execute_process() for a detailed description of the parameters.

Source

scripts/cmake/vcpkg_execute_in_download_mode.cmake