mirror of
https://github.com/Kitware/CMake.git
synced 2026-04-24 07:08:38 -05:00
Autogen: Add documentation for (CMAKE_)AUTOGEN_PARALLEL
This commit is contained in:
@@ -121,6 +121,7 @@ Properties on Targets
|
||||
/prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG
|
||||
/prop_tgt/ARCHIVE_OUTPUT_NAME
|
||||
/prop_tgt/AUTOGEN_BUILD_DIR
|
||||
/prop_tgt/AUTOGEN_PARALLEL
|
||||
/prop_tgt/AUTOGEN_TARGET_DEPENDS
|
||||
/prop_tgt/AUTOMOC_COMPILER_PREDEFINES
|
||||
/prop_tgt/AUTOMOC_DEPEND_FILTERS
|
||||
|
||||
@@ -96,7 +96,8 @@ following targets by setting the :variable:`CMAKE_AUTOMOC` variable. The
|
||||
options to pass to ``moc``. The :variable:`CMAKE_AUTOMOC_MOC_OPTIONS`
|
||||
variable may be populated to pre-set the options for all following targets.
|
||||
|
||||
Additional macro names to search for can be added to :prop_tgt:`AUTOMOC_MACRO_NAMES`.
|
||||
Additional macro names to search for can be added to
|
||||
:prop_tgt:`AUTOMOC_MACRO_NAMES`.
|
||||
|
||||
Additional ``moc`` dependency file names can be extracted from source code
|
||||
by using :prop_tgt:`AUTOMOC_DEPEND_FILTERS`.
|
||||
|
||||
@@ -276,6 +276,7 @@ Variables that Control the Build
|
||||
/variable/CMAKE_ANDROID_STL_TYPE
|
||||
/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY
|
||||
/variable/CMAKE_ARCHIVE_OUTPUT_DIRECTORY_CONFIG
|
||||
/variable/CMAKE_AUTOGEN_PARALLEL
|
||||
/variable/CMAKE_AUTOMOC
|
||||
/variable/CMAKE_AUTOMOC_COMPILER_PREDEFINES
|
||||
/variable/CMAKE_AUTOMOC_DEPEND_FILTERS
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
AUTOGEN_PARALLEL
|
||||
----------------
|
||||
|
||||
Number of parallel ``moc`` or ``uic`` processes to start when using
|
||||
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
|
||||
|
||||
The custom `<origin>_autogen` target starts a number of threads of which
|
||||
each one parses a source file and on demand starts a ``moc`` or ``uic``
|
||||
process. :prop_tgt:`AUTOGEN_PARALLEL` controls how many parallel threads
|
||||
(and therefore ``moc`` or ``uic`` processes) are started.
|
||||
|
||||
- An empty (or unset) value or the string ``AUTO`` sets the number of
|
||||
threads/processes to the number of physical CPUs on the host system.
|
||||
- A positive non zero integer value sets the exact thread/process count.
|
||||
- Otherwise a single thread/process is started.
|
||||
|
||||
By default :prop_tgt:`AUTOGEN_PARALLEL` is initialized from
|
||||
:variable:`CMAKE_AUTOGEN_PARALLEL`.
|
||||
|
||||
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
||||
with Qt.
|
||||
@@ -71,7 +71,8 @@ automoc targets together in an IDE, e.g. in MSVS.
|
||||
The global property :prop_gbl:`AUTOGEN_SOURCE_GROUP` can be used to group
|
||||
files generated by :prop_tgt:`AUTOMOC` together in an IDE, e.g. in MSVS.
|
||||
|
||||
Additional macro names to search for can be added to :prop_tgt:`AUTOMOC_MACRO_NAMES`.
|
||||
Additional macro names to search for can be added to
|
||||
:prop_tgt:`AUTOMOC_MACRO_NAMES`.
|
||||
|
||||
Additional ``moc`` dependency file names can be extracted from source code
|
||||
by using :prop_tgt:`AUTOMOC_DEPEND_FILTERS`.
|
||||
@@ -82,5 +83,8 @@ which is controlled by :prop_tgt:`AUTOMOC_COMPILER_PREDEFINES`.
|
||||
Source C++ files can be excluded from :prop_tgt:`AUTOMOC` processing by
|
||||
enabling :prop_sf:`SKIP_AUTOMOC` or the broader :prop_sf:`SKIP_AUTOGEN`.
|
||||
|
||||
The number of parallel ``moc`` processes to start can be modified by
|
||||
setting :prop_tgt:`AUTOGEN_PARALLEL`.
|
||||
|
||||
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
||||
with Qt.
|
||||
|
||||
@@ -33,5 +33,8 @@ autouic targets together in an IDE, e.g. in MSVS.
|
||||
Source files can be excluded from :prop_tgt:`AUTOUIC` processing by
|
||||
enabling :prop_sf:`SKIP_AUTOUIC` or the broader :prop_sf:`SKIP_AUTOGEN`.
|
||||
|
||||
The number of parallel ``uic`` processes to start can be modified by
|
||||
setting :prop_tgt:`AUTOGEN_PARALLEL`.
|
||||
|
||||
See the :manual:`cmake-qt(7)` manual for more information on using CMake
|
||||
with Qt.
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
CMAKE_AUTOGEN_PARALLEL
|
||||
----------------------
|
||||
|
||||
Number of parallel ``moc`` or ``uic`` processes to start when using
|
||||
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
|
||||
|
||||
This variable is used to initialize the :prop_tgt:`AUTOGEN_PARALLEL` property
|
||||
on all the targets. See that target property for additional information.
|
||||
|
||||
By default :variable:`CMAKE_AUTOGEN_PARALLEL` is unset.
|
||||
Reference in New Issue
Block a user