From 5ebf65665dfbf29abeb49410070c2102490fd476 Mon Sep 17 00:00:00 2001
From: Vinny <vpaladino778@gmail.com>
Date: Tue, 1 Oct 2019 11:21:04 -0400
Subject: [Documentation] Added documentation page for
 vcpkg_fixup_cmake_targets.cmake (#8365)

* Added documentation page for vcpkg_fixup_cmake_targets.cmake, added example usage comment to .cmake file

* Update cmake_fixup_cmake_targets.md

* Update cmake_fixup_cmake_targets.md
---
 docs/maintainers/cmake_fixup_cmake_targets.md | 25 +++++++++++++++++++++++++
 scripts/cmake/vcpkg_fixup_cmake_targets.cmake | 14 ++++++++------
 2 files changed, 33 insertions(+), 6 deletions(-)
 create mode 100644 docs/maintainers/cmake_fixup_cmake_targets.md

diff --git a/docs/maintainers/cmake_fixup_cmake_targets.md b/docs/maintainers/cmake_fixup_cmake_targets.md
new file mode 100644
index 000000000..9bbaddbba
--- /dev/null
+++ b/docs/maintainers/cmake_fixup_cmake_targets.md
@@ -0,0 +1,25 @@
+# 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/scripts/cmake/vcpkg_fixup_cmake_targets.cmake b/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
index 1e0f2493d..3b5370bcd 100644
--- a/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
+++ b/scripts/cmake/vcpkg_fixup_cmake_targets.cmake
@@ -1,21 +1,23 @@
 #.rst:
 # .. command:: vcpkg_fixup_cmake_targets
 #
-#  Transform all /debug/share/<port>/*targets-debug.cmake files and move them to /share/<port>.
+#  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
 #
-#  Transform all references matching /bin/*.exe to /tools/<port>/*.exe on Windows
-#  Transform all references matching /bin/* to /tools/<port>/* on other platforms
+#  Transforms all references matching /bin/*.exe to /tools/<port>/*.exe on Windows
+#  Transforms all references matching /bin/* to /tools/<port>/* on other platforms
 #
-#  Fix ${_IMPORT_PREFIX} in auto generated targets to be one folder deeper. 
-#  Replace ${CURRENT_INSTALLED_DIR} with ${_IMPORT_PREFIX} in configs/targets.
+#  Fixes ${_IMPORT_PREFIX} in auto generated targets to be one folder deeper. 
+#  Replaces ${CURRENT_INSTALLED_DIR} with ${_IMPORT_PREFIX} in configs/targets.
 #
 #  ::
 #  vcpkg_fixup_cmake_targets([CONFIG_PATH <config_path>])
 #
 #  ``CONFIG_PATH``
 #    *.cmake files subdirectory (like "lib/cmake/${PORT}").
-#
+# 
+#	Example usage:
+# 		vcpkg_fixup_cmake_targets(CONFIG_PATH "lib/cmake/myPort")
 
 function(vcpkg_fixup_cmake_targets)
     cmake_parse_arguments(_vfct "" "CONFIG_PATH;TARGET_PATH" "" ${ARGN})
-- 
cgit v1.2.3