summaryrefslogtreecommitdiffstats
path: root/Help/prop_sf/VS_SETTINGS.rst
diff options
context:
space:
mode:
authorMatt Davies <matthew.davies@sony.com>2020-03-27 15:40:43 (GMT)
committerBrad King <brad.king@kitware.com>2020-03-27 16:01:21 (GMT)
commit0723e04f7a13ca1b1ae5c4ef2c603b922bcf82e8 (patch)
tree66de081ad2b7fe2d3cdb2ee71c068b7265f3defe /Help/prop_sf/VS_SETTINGS.rst
parent2ca1102f8347b0d25b476a9a785977f2dc8a812b (diff)
downloadCMake-0723e04f7a13ca1b1ae5c4ef2c603b922bcf82e8.zip
CMake-0723e04f7a13ca1b1ae5c4ef2c603b922bcf82e8.tar.gz
CMake-0723e04f7a13ca1b1ae5c4ef2c603b922bcf82e8.tar.bz2
VS: Add documentation for VS_SETTINGS and VS_SOURCE_SETTINGS_<tool>.
Diffstat (limited to 'Help/prop_sf/VS_SETTINGS.rst')
-rw-r--r--Help/prop_sf/VS_SETTINGS.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/Help/prop_sf/VS_SETTINGS.rst b/Help/prop_sf/VS_SETTINGS.rst
new file mode 100644
index 0000000..0719406
--- /dev/null
+++ b/Help/prop_sf/VS_SETTINGS.rst
@@ -0,0 +1,18 @@
+VS_SETTINGS
+-----------
+
+Set any item metadata on a non-built file.
+
+Takes a list of ``Key=Value`` pairs. Tells the Visual Studio generator to set
+``Key`` to ``Value`` as item metadata on the file.
+
+For example:
+
+.. code-block:: cmake
+
+ set_property(SOURCE file.hlsl PROPERTY VS_SETTINGS "Key=Value" "Key2=Value2")
+
+will set ``Key`` to ``Value`` and ``Key2`` to ``Value2`` on the
+``file.hlsl`` item as metadata.
+
+Generator expressions are supported.