diff options
Diffstat (limited to 'docs/maintainers/internal')
| -rw-r--r-- | docs/maintainers/internal/z_vcpkg_function_arguments.md | 27 | ||||
| -rw-r--r-- | docs/maintainers/internal/z_vcpkg_prettify_command_line.md | 19 |
2 files changed, 46 insertions, 0 deletions
diff --git a/docs/maintainers/internal/z_vcpkg_function_arguments.md b/docs/maintainers/internal/z_vcpkg_function_arguments.md new file mode 100644 index 000000000..e60407f20 --- /dev/null +++ b/docs/maintainers/internal/z_vcpkg_function_arguments.md @@ -0,0 +1,27 @@ +# z_vcpkg_function_arguments + +**Only for internal use in vcpkg helpers. Behavior and arguments will change without notice.** +Get a list of the arguments which were passed in. +Unlike `ARGV`, which is simply the arguments joined with `;`, +so that `(A B)` is not distinguishable from `("A;B")`, +this macro gives `"A;B"` for the first argument list, +and `"A\;B"` for the second. + +```cmake +z_vcpkg_function_arguments(<out-var> [<N>]) +``` + +`z_vcpkg_function_arguments` gets the arguments between `ARGV<N>` and the last argument. +`<N>` defaults to `0`, so that all arguments are taken. + +## Example: +```cmake +function(foo_replacement) + z_vcpkg_function_arguments(ARGS) + foo(${ARGS}) + ... +endfunction() +``` + +## Source +[scripts/cmake/z_vcpkg_function_arguments.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/z_vcpkg_function_arguments.cmake) diff --git a/docs/maintainers/internal/z_vcpkg_prettify_command_line.md b/docs/maintainers/internal/z_vcpkg_prettify_command_line.md new file mode 100644 index 000000000..1b7636630 --- /dev/null +++ b/docs/maintainers/internal/z_vcpkg_prettify_command_line.md @@ -0,0 +1,19 @@ +# z_vcpkg_prettify_command_line + +**Only for internal use in vcpkg helpers. Behavior and arguments will change without notice.** +Turn a command line into a formatted string. + +```cmake +z_vcpkg_prettify_command_line(<out-var> <argument>...) +``` + +This command is for internal use, when printing out to a message. + +## Examples + +* `scripts/cmake/vcpkg_execute_build_process.cmake` +* `scripts/cmake/vcpkg_execute_required_process.cmake` +* `scripts/cmake/vcpkg_execute_required_process_repeat.cmake` + +## Source +[scripts/cmake/z_vcpkg_prettify_command_line.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/z_vcpkg_prettify_command_line.cmake) |