From 85e7e815f17d3a316089f9aa3bc0ee3c2a13039d Mon Sep 17 00:00:00 2001
From: Vinny <vpaladino778@gmail.com>
Date: Wed, 2 Oct 2019 10:08:51 -0400
Subject: Update and rename cmake_fixup_cmake_targets.md to
 vcpkg_fixup_cmake_targets.md (#8424)

Corrected incorrect file name.
Added inline code for reading clarity
Added examples
---
 docs/maintainers/cmake_fixup_cmake_targets.md | 25 ----------------------
 docs/maintainers/vcpkg_fixup_cmake_targets.md | 30 +++++++++++++++++++++++++++
 2 files changed, 30 insertions(+), 25 deletions(-)
 delete mode 100644 docs/maintainers/cmake_fixup_cmake_targets.md
 create mode 100644 docs/maintainers/vcpkg_fixup_cmake_targets.md

(limited to 'docs')

diff --git a/docs/maintainers/cmake_fixup_cmake_targets.md b/docs/maintainers/cmake_fixup_cmake_targets.md
deleted file mode 100644
index 9bbaddbba..000000000
--- a/docs/maintainers/cmake_fixup_cmake_targets.md
+++ /dev/null
@@ -1,25 +0,0 @@
-# vcpkg_fixup_cmake_targets
-
-Transforms all /debug/share/\<port\>/\*targets-debug.cmake files and move them to /share/\<port\>.
-Removes all /debug/share/\<port\>/\*targets.cmake and /debug/share/\<port\>/\*config.cmake.
-
-Transforms all references matching /bin/\*.exe tools/\<port\>/\*.exe on Windows.
-Transforms all references matching /bin/\* to /tools/\<port\>/\* on other platforms.
-
-Fixups ${_IMPORT_PREFIX} in auto generated targets to be one folder deeper. 
-Replaces ${CURRENT_INSTALLED_DIR} with ${_IMPORT_PREFIX} in config files and targets.
-
-
-## Usage
-```cmake
-vcpkg_fixup_cmake_targets(CONFIG_PATH <config_path>)
-```
-
-## Parameters:
-### CONFIG_PATH
-*.cmake files subdirectory (e.g. "lib/cmake/${PORT}" or "cmake/${PORT}).
-### TARGET_PATH
-Optional location to place fixup'd files. Unecessary if target is "share/${PORT}".
-
-## Source
-[scripts/cmake/cmake_fixup_cmake_targets.cmake](https://github.com/microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_fixup_cmake_targets.cmake)
diff --git a/docs/maintainers/vcpkg_fixup_cmake_targets.md b/docs/maintainers/vcpkg_fixup_cmake_targets.md
new file mode 100644
index 000000000..5bad80656
--- /dev/null
+++ b/docs/maintainers/vcpkg_fixup_cmake_targets.md
@@ -0,0 +1,30 @@
+# vcpkg_fixup_cmake_targets
+
+Transforms all `/debug/share/\<port\>/\*targets-debug.cmake` files and move them to `/share/\<port\>`.
+Removes all `/debug/share/\<port\>/\*targets.cmake and /debug/share/\<port\>/\*config.cmake`.
+
+Transforms all references matching `/bin/\*.exe tools/\<port\>/\*.exe` on Windows.
+Transforms all references matching `/bin/\* to /tools/\<port\>/\*` on other platforms.
+
+Fixups *${_IMPORT_PREFIX}* in auto generated targets to be one folder deeper. 
+Replaces *${CURRENT_INSTALLED_DIR}* with *${_IMPORT_PREFIX}* in config files and targets.
+
+
+## Usage
+```cmake
+vcpkg_fixup_cmake_targets(CONFIG_PATH <config_path>)
+```
+
+## Parameters:
+### CONFIG_PATH
+*.cmake files subdirectory (e.g. "lib/cmake/${PORT}" or "cmake/${PORT}).
+### TARGET_PATH
+Optional location to place fixup'd files. Unecessary if target is "share/${PORT}".
+
+## Examples:
+  - [Azure-uamqp-c](https://github.com/microsoft/vcpkg/blob/master/ports/azure-uamqp-c/portfile.cmake)
+  - [Brigand](https://github.com/microsoft/vcpkg/blob/master/ports/brigand/portfile.cmake)
+  - [cctz](https://github.com/microsoft/vcpkg/blob/master/ports/cctz/portfile.cmake)
+
+## Source
+[scripts/cmake/vcpkg_fixup_cmake_targets.cmake](https://github.com/microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_fixup_cmake_targets.cmake)
-- 
cgit v1.2.3