diff options
| author | Brad King <brad.king@kitware.com> | 2021-01-21 17:08:48 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2021-01-22 20:29:10 (GMT) |
| commit | 3c80666f00d94a762d768130cfa6adce6eb21487 (patch) | |
| tree | 9d111854bc9aa6d3370e16cb901b8b744bf6c254 | |
| parent | c69567e56a3b4ba4eb6e02112b95c0143894d598 (diff) | |
| download | CMake-3c80666f00d94a762d768130cfa6adce6eb21487.zip CMake-3c80666f00d94a762d768130cfa6adce6eb21487.tar.gz CMake-3c80666f00d94a762d768130cfa6adce6eb21487.tar.bz2 | |
Help: Document intended purpose of XCODE_ATTRIBUTE_<an-attribute>
Also warn the reader against setting values CMake normally generates.
Issue: #21728
| -rw-r--r-- | Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst | 8 | ||||
| -rw-r--r-- | Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst | 10 |
2 files changed, 15 insertions, 3 deletions
diff --git a/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst index 71858c5..fbe7608 100644 --- a/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst +++ b/Help/prop_tgt/XCODE_ATTRIBUTE_an-attribute.rst @@ -3,9 +3,15 @@ XCODE_ATTRIBUTE_<an-attribute> Set Xcode target attributes directly. -Tell the :generator:`Xcode` generator to set '<an-attribute>' to a given +Tell the :generator:`Xcode` generator to set ``<an-attribute>`` to a given value in the generated Xcode project. Ignored on other generators. +This offers low-level control over the generated Xcode project file. +It is meant as a last resort for specifying settings that CMake does +not otherwise have a way to control. Although this can override a +setting CMake normally produces on its own, doing so bypasses CMake's +model of the project and can break things. + See the :variable:`CMAKE_XCODE_ATTRIBUTE_<an-attribute>` variable to set attributes on all targets in a directory tree. diff --git a/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst b/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst index 90e4c0e..ffa0a4c 100644 --- a/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst +++ b/Help/variable/CMAKE_XCODE_ATTRIBUTE_an-attribute.rst @@ -5,8 +5,14 @@ CMAKE_XCODE_ATTRIBUTE_<an-attribute> Set Xcode target attributes directly. -Tell the :generator:`Xcode` generator to set '<an-attribute>' to a given value -in the generated Xcode project. Ignored on other generators. +Tell the :generator:`Xcode` generator to set ``<an-attribute>`` to a given +value in the generated Xcode project. Ignored on other generators. + +This offers low-level control over the generated Xcode project file. +It is meant as a last resort for specifying settings that CMake does +not otherwise have a way to control. Although this can override a +setting CMake normally produces on its own, doing so bypasses CMake's +model of the project and can break things. See the :prop_tgt:`XCODE_ATTRIBUTE_<an-attribute>` target property to set attributes on a specific target. |