Help: Document intended purpose of XCODE_ATTRIBUTE_<an-attribute>

Also warn the reader against setting values CMake normally generates.

Issue: #21728
This commit is contained in:
Brad King 2021-01-21 12:08:48 -05:00 committed by Craig Scott
parent c69567e56a
commit 3c80666f00
2 changed files with 15 additions and 3 deletions

View File

@ -3,9 +3,15 @@ XCODE_ATTRIBUTE_<an-attribute>
Set Xcode target attributes directly. 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. 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 See the :variable:`CMAKE_XCODE_ATTRIBUTE_<an-attribute>` variable
to set attributes on all targets in a directory tree. to set attributes on all targets in a directory tree.

View File

@ -5,8 +5,14 @@ CMAKE_XCODE_ATTRIBUTE_<an-attribute>
Set Xcode target attributes directly. Set Xcode target attributes directly.
Tell the :generator:`Xcode` generator to set '<an-attribute>' to a given value Tell the :generator:`Xcode` generator to set ``<an-attribute>`` to a given
in the generated Xcode project. Ignored on other generators. 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 See the :prop_tgt:`XCODE_ATTRIBUTE_<an-attribute>` target property
to set attributes on a specific target. to set attributes on a specific target.