The following issue has been SUBMITTED.
======================================================================
http://www.cmake.org/Bug/view.php?id=14427
======================================================================
Reported By: Rob Stewart
Assigned To:
======================================================================
Project: CMake
Issue ID: 14427
Category: Documentation
Reproducibility: N/A
Severity: text
Priority: normal
Status: new
======================================================================
Date Submitted: 2013-09-19 15:50 EDT
Last Modified: 2013-09-19 15:50 EDT
======================================================================
Summary: SET_SOURCE_FILES_PROPERTIES() Documentation Unclear
Description:
The documentation doesn't make clear that it replaces the existing property
values with those being set, presuming I interpret its behavior correctly. That
is, "set" implies the current value is replaced (as opposed to "add"). What's
more, the syntax for multiword values is left to be inferred. Therefore, I
suggest the wording below.
I took the liberty of reformatting the signature, too. I think repetition is
better rendered as shown. You can refer to "name" and "value" generically in
the text (possibly with notation like <name> to highlight a parameter reference)
without resorting to enumerating all variations in the signature.
set_source_files_properties: Sets properties that affect how certain source
files are built.
set_source_files_properties([file [file [...]]]
PROPERTIES name value [name value [...]])
Properties can be set on the multiple source files. PROPERTIES expects one or
more property name/value pairs. This means that when <value> contains multiple
word, it must be quoted. Unknown property names are ignored silently. Refer to
the properties documentation for those known to CMake.
NOTE: Source file properties are visible only to targets added in the same
(CMAKE_CURRENT_LIST_DIR) directory.
======================================================================
Issue History
Date Modified Username Field Change
======================================================================
2013-09-19 15:50 Rob Stewart New Issue
======================================================================
--
Powered by www.kitware.com
Visit other Kitware open-source projects at
http://www.kitware.com/opensource/opensource.html
Please keep messages on-topic and check the CMake FAQ at:
http://www.cmake.org/Wiki/CMake_FAQ
Follow this link to subscribe/unsubscribe:
http://public.kitware.com/cgi-bin/mailman/listinfo/cmake-developers
