summaryrefslogtreecommitdiff
path: root/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst
diff options
context:
space:
mode:
authorDan Johnston <dan.e.johnston@gmail.com>2020-01-14 10:17:15 -0800
committerBrad King <brad.king@kitware.com>2020-01-16 10:32:25 -0500
commit97c124e30f530f64fafdc2b3a9decd1bf31bcf9c (patch)
treefa51db1fb364e307b3a46ff08a9c3ed4feece622 /Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst
parentebd0b16ddbfc64d627aae7acb991aefa7179fa8b (diff)
downloadcmake-97c124e30f530f64fafdc2b3a9decd1bf31bcf9c.tar.gz
Ninja: Add a separate job pool for PCH creation
Add a `JOB_POOL_PRECOMPILE_HEADER` target property to specify the pool name, and its associated `CMAKE_JOB_POOL_PRECOMPILE_HEADER` variable. Fixes: #20217
Diffstat (limited to 'Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst')
-rw-r--r--Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst b/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst
new file mode 100644
index 0000000000..ece28a4e81
--- /dev/null
+++ b/Help/prop_tgt/JOB_POOL_PRECOMPILE_HEADER.rst
@@ -0,0 +1,21 @@
+JOB_POOL_PRECOMPILE_HEADER
+--------------------------
+
+Ninja only: Pool used for generating pre-compiled headers.
+
+The number of parallel compile processes could be limited by defining
+pools with the global :prop_gbl:`JOB_POOLS`
+property and then specifying here the pool name.
+
+For instance:
+
+.. code-block:: cmake
+
+ set_property(TARGET myexe PROPERTY JOB_POOL_PRECOMPILE_HEADER two_jobs)
+
+This property is initialized by the value of
+:variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER`.
+
+If neither :prop_tgt:`JOB_POOL_PRECOMPILE_HEADER` nor
+:variable:`CMAKE_JOB_POOL_PRECOMPILE_HEADER` are set then
+:prop_tgt:`JOB_POOL_COMPILE` will be used for this task.