vcpkg/docs/maintainers/internal/z_vcpkg_prettify_command_line.md

# z_vcpkg_prettify_command_line

The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/).

**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)
[(z_)vcpkg_prettify_command(_line)] Scripts Tree Audit (#16130) * [vcpkg_prettify_command] Audit * rename file * rename out-var in docs * fix file path * add internal use message to docs * escapin' in z_vcpkg_prettify_command_line * regenerate docs 2021-02-10 07:53:36 +08:00			`# z_vcpkg_prettify_command_line`

[docs] Fix the automatically generated document URL (#16611) * [document] Fix the automatically generated document URL * [docs] Format all documents 2021-03-11 01:56:07 +08:00			`The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/).`
[scripts-audit] Rollup PR 2021-02-26 (#16440) * [scripts-audit rollup] PR #16419 * pull the cmake doc comment parsing out into its own function * support cmake helper ports * add real support for deprecation, as opposed to ad-hoc * [scripts-audit rollup] PR #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 Deprecate `vcpkg__cmake` in favor of `vcpkg_cmake_` from the `vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets` in favor of `vcpkg_cmake_config_fixup` from the `vcpkg-cmake-config` port. 2021-03-01 05:17:19 +08:00
[(z_)vcpkg_prettify_command(_line)] Scripts Tree Audit (#16130) * [vcpkg_prettify_command] Audit * rename file * rename out-var in docs * fix file path * add internal use message to docs * escapin' in z_vcpkg_prettify_command_line * regenerate docs 2021-02-10 07:53:36 +08:00			`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-audit] Rollup PR 2021-02-26 (#16440) * [scripts-audit rollup] PR #16419 * pull the cmake doc comment parsing out into its own function * support cmake helper ports * add real support for deprecation, as opposed to ad-hoc * [scripts-audit rollup] PR #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 Deprecate `vcpkg__cmake` in favor of `vcpkg_cmake_` from the `vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets` in favor of `vcpkg_cmake_config_fixup` from the `vcpkg-cmake-config` port. 2021-03-01 05:17:19 +08:00			`[scripts/cmake/z\_vcpkg\_prettify\_command\_line.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/z_vcpkg_prettify_command_line.cmake)`