diff options
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/prop_dir/LISTFILE_STACK.rst | 5 | ||||
| -rw-r--r-- | Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst | 9 | ||||
| -rw-r--r-- | Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst | 11 | ||||
| -rw-r--r-- | Help/prop_gbl/IN_TRY_COMPILE.rst | 3 | ||||
| -rw-r--r-- | Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst | 4 | ||||
| -rw-r--r-- | Help/prop_gbl/RULE_MESSAGES.rst | 6 | ||||
| -rw-r--r-- | Help/prop_gbl/USE_FOLDERS.rst | 7 | ||||
| -rw-r--r-- | Help/prop_sf/COMPILE_FLAGS.rst | 4 | ||||
| -rw-r--r-- | Help/prop_test/ATTACHED_FILES_ON_FAIL.rst | 4 | ||||
| -rw-r--r-- | Help/prop_tgt/AUTOMOC.rst | 45 | ||||
| -rw-r--r-- | Help/prop_tgt/COMPILE_FLAGS.rst | 10 | ||||
| -rw-r--r-- | Help/release/dev/ExternalProject-git-clone-shallow.rst | 5 | ||||
| -rw-r--r-- | Help/release/dev/automoc-diagnostics.rst | 6 | ||||
| -rw-r--r-- | Help/release/dev/fix-bison-flex-command-escaping.rst | 12 |
14 files changed, 86 insertions, 45 deletions
diff --git a/Help/prop_dir/LISTFILE_STACK.rst b/Help/prop_dir/LISTFILE_STACK.rst index f729c1e..22ec4b6 100644 --- a/Help/prop_dir/LISTFILE_STACK.rst +++ b/Help/prop_dir/LISTFILE_STACK.rst @@ -5,5 +5,6 @@ The current stack of listfiles being processed. This property is mainly useful when trying to debug errors in your CMake scripts. It returns a list of what list files are currently -being processed, in order. So if one listfile does an INCLUDE command -then that is effectively pushing the included listfile onto the stack. +being processed, in order. So if one listfile does an +:command:`include` command then that is effectively pushing the +included listfile onto the stack. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst b/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst index 185246c..e52f8eb 100644 --- a/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst +++ b/Help/prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.rst @@ -1,9 +1,10 @@ FIND_LIBRARY_USE_LIB64_PATHS ---------------------------- -Whether FIND_LIBRARY should automatically search lib64 directories. +Whether :command:`find_library` should automatically search lib64 +directories. FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the -FIND_LIBRARY command should automatically search the lib64 variant of -directories called lib in the search path when building 64-bit -binaries. +:command:`find_library` command should automatically search the lib64 +variant of directories called lib in the search path when building +64-bit binaries. diff --git a/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst b/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst index 9a3edd8..beb94ac 100644 --- a/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst +++ b/Help/prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING.rst @@ -1,9 +1,10 @@ FIND_LIBRARY_USE_OPENBSD_VERSIONING ----------------------------------- -Whether FIND_LIBRARY should find OpenBSD-style shared libraries. +Whether :command:`find_library` should find OpenBSD-style shared +libraries. -This property is a boolean specifying whether the FIND_LIBRARY command -should find shared libraries with OpenBSD-style versioned extension: -".so.<major>.<minor>". The property is set to true on OpenBSD and -false on other platforms. +This property is a boolean specifying whether the +:command:`find_library` command should find shared libraries with +OpenBSD-style versioned extension: ".so.<major>.<minor>". The +property is set to true on OpenBSD and false on other platforms. diff --git a/Help/prop_gbl/IN_TRY_COMPILE.rst b/Help/prop_gbl/IN_TRY_COMPILE.rst index 3a2ef5b..fd2d2e1 100644 --- a/Help/prop_gbl/IN_TRY_COMPILE.rst +++ b/Help/prop_gbl/IN_TRY_COMPILE.rst @@ -3,4 +3,5 @@ IN_TRY_COMPILE Read-only property that is true during a try-compile configuration. -True when building a project inside a TRY_COMPILE or TRY_RUN command. +True when building a project inside a :command:`try_compile` or +:command:`try_run` command. diff --git a/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst b/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst index e85b823..bf8c9a3 100644 --- a/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst +++ b/Help/prop_gbl/PREDEFINED_TARGETS_FOLDER.rst @@ -5,5 +5,5 @@ Name of FOLDER for targets that are added automatically by CMake. If not set, CMake uses "CMakePredefinedTargets" as a default value for this property. Targets such as INSTALL, PACKAGE and RUN_TESTS will be -organized into this FOLDER. See also the documentation for the FOLDER -target property. +organized into this FOLDER. See also the documentation for the +:prop_tgt:`FOLDER` target property. diff --git a/Help/prop_gbl/RULE_MESSAGES.rst b/Help/prop_gbl/RULE_MESSAGES.rst index 38d83a3..87a5ca6 100644 --- a/Help/prop_gbl/RULE_MESSAGES.rst +++ b/Help/prop_gbl/RULE_MESSAGES.rst @@ -8,6 +8,6 @@ progress message describing what each build rule does. If the property is not set the default is ON. Set the property to OFF to disable granular messages and report only as each target completes. This is intended to allow scripted builds to avoid the build time cost -of detailed reports. If a CMAKE_RULE_MESSAGES cache entry exists its -value initializes the value of this property. Non-Makefile generators -currently ignore this property. +of detailed reports. If a ``CMAKE_RULE_MESSAGES`` cache entry exists +its value initializes the value of this property. Non-Makefile +generators currently ignore this property. diff --git a/Help/prop_gbl/USE_FOLDERS.rst b/Help/prop_gbl/USE_FOLDERS.rst index fdbca9f..a1b4ccb 100644 --- a/Help/prop_gbl/USE_FOLDERS.rst +++ b/Help/prop_gbl/USE_FOLDERS.rst @@ -1,9 +1,10 @@ USE_FOLDERS ----------- -Use the FOLDER target property to organize targets into folders. +Use the :prop_tgt:`FOLDER` target property to organize targets into +folders. If not set, CMake treats this property as OFF by default. CMake generators that are capable of organizing into a hierarchy of folders -use the values of the FOLDER target property to name those folders. -See also the documentation for the FOLDER target property. +use the values of the :prop_tgt:`FOLDER` target property to name those +folders. See also the documentation for the FOLDER target property. diff --git a/Help/prop_sf/COMPILE_FLAGS.rst b/Help/prop_sf/COMPILE_FLAGS.rst index daba502..086a063 100644 --- a/Help/prop_sf/COMPILE_FLAGS.rst +++ b/Help/prop_sf/COMPILE_FLAGS.rst @@ -4,5 +4,5 @@ COMPILE_FLAGS Additional flags to be added when compiling this source file. These flags will be added to the list of compile flags when this -source file builds. Use COMPILE_DEFINITIONS to pass additional -preprocessor definitions. +source file builds. Use :prop_sf:`COMPILE_DEFINITIONS` to pass +additional preprocessor definitions. diff --git a/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst b/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst index 6819143..add54b2 100644 --- a/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst +++ b/Help/prop_test/ATTACHED_FILES_ON_FAIL.rst @@ -3,5 +3,5 @@ ATTACHED_FILES_ON_FAIL Attach a list of files to a dashboard submission if the test fails. -Same as ATTACHED_FILES, but these files will only be included if the -test does not pass. +Same as :prop_test:`ATTACHED_FILES`, but these files will only be +included if the test does not pass. 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/prop_tgt/COMPILE_FLAGS.rst b/Help/prop_tgt/COMPILE_FLAGS.rst index 6ee6c51..1a5389e 100644 --- a/Help/prop_tgt/COMPILE_FLAGS.rst +++ b/Help/prop_tgt/COMPILE_FLAGS.rst @@ -3,9 +3,9 @@ COMPILE_FLAGS Additional flags to use when compiling this target's sources. -The COMPILE_FLAGS property sets additional compiler flags used to -build sources within the target. Use COMPILE_DEFINITIONS to pass -additional preprocessor definitions. +The ``COMPILE_FLAGS`` property sets additional compiler flags used to +build sources within the target. Use :prop_tgt:`COMPILE_DEFINITIONS` +to pass additional preprocessor definitions. -This property is deprecated. Use the COMPILE_OPTIONS property or the -target_compile_options command instead. +This property is deprecated. Use the :prop_tgt:`COMPILE_OPTIONS` +property or the command:`target_compile_options` command instead. diff --git a/Help/release/dev/ExternalProject-git-clone-shallow.rst b/Help/release/dev/ExternalProject-git-clone-shallow.rst new file mode 100644 index 0000000..f06fe34 --- /dev/null +++ b/Help/release/dev/ExternalProject-git-clone-shallow.rst @@ -0,0 +1,5 @@ +ExternalProject-git-clone-shallow +--------------------------------- + +* The :module:`ExternalProject` module leared the ``GIT_SHALLOW 1`` + option to perform a shallow clone of a Git repository. 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). diff --git a/Help/release/dev/fix-bison-flex-command-escaping.rst b/Help/release/dev/fix-bison-flex-command-escaping.rst new file mode 100644 index 0000000..dc2e87b --- /dev/null +++ b/Help/release/dev/fix-bison-flex-command-escaping.rst @@ -0,0 +1,12 @@ +fix-bison-flex-command-escaping +------------------------------- + +* The :module:`FindBISON` module ``BISON_TARGET`` macro now supports + special characters by passing the ``VERBATIM`` option to internal + :command:`add_custom_command` calls. This may break clients that + added escaping manually to work around the bug. + +* The :module:`FindFLEX` module ``FLEX_TARGET`` macro now supports + special characters by passing the ``VERBATIM`` option to internal + :command:`add_custom_command` calls. This may break clients that + added escaping manually to work around the bug. |