summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-04-22 13:02:03 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2016-04-22 13:02:03 (GMT)
commit76e793b9ad1483f6f397f630fdc5d4fcaf141c06 (patch)
tree582cd580542660959c455431e24e3073838f0375 /Help
parenteb87407068070d38dbac06a1542b9c3e63ce7fa7 (diff)
parent84946c735cc6d2b8f8e014f4772dd602b4a83a16 (diff)
downloadCMake-76e793b9ad1483f6f397f630fdc5d4fcaf141c06.zip
CMake-76e793b9ad1483f6f397f630fdc5d4fcaf141c06.tar.gz
CMake-76e793b9ad1483f6f397f630fdc5d4fcaf141c06.tar.bz2
Merge topic 'autogen-updates'
84946c73 Tests: QtAutogen: Same source name in different directories test 9c6fa684 Autogen: Generate qrc_NAME.cpp files in subdirectories 488ea8c7 Autogen: Generate not included moc files in subdirectories (#12873) 66caae45 Autogen: Check added for name collisions of generated qrc_NAME.cpp files 663d093d Autogen: Check added for name collisions of generated ui_NAME.h files 8295d437 Autogen: Check added for name collisions of generated moc files d350308a Help: Improve AUTOMOC documentation layout
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_tgt/AUTOMOC.rst45
-rw-r--r--Help/release/dev/automoc-diagnostics.rst6
2 files changed, 35 insertions, 16 deletions
diff --git a/Help/prop_tgt/AUTOMOC.rst b/Help/prop_tgt/AUTOMOC.rst
index 045ebb2..8143ba9 100644
--- a/Help/prop_tgt/AUTOMOC.rst
+++ b/Help/prop_tgt/AUTOMOC.rst
@@ -6,22 +6,35 @@ Should the target be processed with automoc (for Qt projects).
AUTOMOC is a boolean specifying whether CMake will handle the Qt ``moc``
preprocessor automatically, i.e. without having to use the
:module:`QT4_WRAP_CPP() <FindQt4>` or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are
-supported. When this property is set ``ON``, CMake will scan the
-source files at build time and invoke moc accordingly. If an ``#include``
-statement like ``#include "moc_foo.cpp"`` is found, the ``Q_OBJECT`` class
-declaration is expected in the header, and ``moc`` is run on the header
-file. If an ``#include`` statement like ``#include "foo.moc"`` is found, then
-a ``Q_OBJECT`` is expected in the current source file and ``moc`` is run on
-the file itself. Additionally, header files with the same base name (like
-``foo.h``) or ``_p`` appended to the base name (like ``foo_p.h``) are parsed
-for ``Q_OBJECT`` macros, and if found, ``moc`` is also executed on those files.
-``AUTOMOC`` checks multiple header alternative extensions, such as
-``hpp``, ``hxx`` etc when searching for headers.
-The resulting moc files, which are not included as shown above in any
-of the source files are included in a generated
-``<targetname>_automoc.cpp`` file, which is compiled as part of the
-target. This property is initialized by the value of the
-:variable:`CMAKE_AUTOMOC` variable if it is set when a target is created.
+supported.
+
+When this property is set ``ON``, CMake will scan the
+source files at build time and invoke moc accordingly.
+
+* If an ``#include`` statement like ``#include "moc_foo.cpp"`` is found,
+ the ``Q_OBJECT`` class declaration is expected in the header, and
+ ``moc`` is run on the header file. A ``moc_foo.cpp`` file will be
+ generated from the source's header into the
+ :variable:`CMAKE_CURRENT_BINARY_DIR` directory. This allows the
+ compiler to find the included ``moc_foo.cpp`` file regardless of the
+ location the original source. However, if multiple source files
+ in different directories do this then their generated moc files would
+ collide. In this case a diagnostic will be issued.
+
+* If an ``#include`` statement like ``#include "foo.moc"`` is found,
+ then a ``Q_OBJECT`` is expected in the current source file and ``moc``
+ is run on the file itself. Additionally, header files with the same
+ base name (like ``foo.h``) or ``_p`` appended to the base name (like
+ ``foo_p.h``) are parsed for ``Q_OBJECT`` macros, and if found, ``moc``
+ is also executed on those files. ``AUTOMOC`` checks multiple header
+ alternative extensions, such as ``hpp``, ``hxx`` etc when searching
+ for headers. The resulting moc files, which are not included as shown
+ above in any of the source files are included in a generated
+ ``<targetname>_automoc.cpp`` file, which is compiled as part of the
+ target.
+
+This property is initialized by the value of the :variable:`CMAKE_AUTOMOC`
+variable if it is set when a target is created.
Additional command line options for moc can be set via the
:prop_tgt:`AUTOMOC_MOC_OPTIONS` property.
diff --git a/Help/release/dev/automoc-diagnostics.rst b/Help/release/dev/automoc-diagnostics.rst
new file mode 100644
index 0000000..d89f2e1
--- /dev/null
+++ b/Help/release/dev/automoc-diagnostics.rst
@@ -0,0 +1,6 @@
+automoc-diagnostics
+-------------------
+
+* :prop_tgt:`AUTOMOC` now diagnoses name collisions when multiple source
+ files in different directories use ``#include <moc_foo.cpp>`` with the
+ same name (because the generated ``moc_foo.cpp`` files would collide).