Browse Source

Help: Improve language in INSTALL_PARALLEL doc

Remove unneeded comma, clarify and link reference to Ninja generators, and substitute ``ON`` for enabled.
pull/376/head
Martin Duffy 6 months ago
parent
commit
f1a80380ae
  1. 4
      Help/prop_gbl/INSTALL_PARALLEL.rst

4
Help/prop_gbl/INSTALL_PARALLEL.rst

@ -6,7 +6,7 @@ INSTALL_PARALLEL
Enables parallel installation option for a project. The install code for each Enables parallel installation option for a project. The install code for each
subdirectory added with ``add_subdirectory`` can run independently. subdirectory added with ``add_subdirectory`` can run independently.
When using the Ninja generator, setting this property to ``ON``, causes
When using the :ref:`Ninja Generators`, enabling this property causes
``install/local`` targets have the console pool disabled, allowing them to run ``install/local`` targets have the console pool disabled, allowing them to run
concurrently. concurrently.
@ -15,7 +15,7 @@ explicit dependency on the ``install/local`` target for each subdirectory.
.. versionadded:: 3.31 .. versionadded:: 3.31
When this property is ``ON``, ``cmake --install`` can be given the ``-j <jobs>``
When this property is enabled, ``cmake --install`` can be given the ``-j <jobs>``
or ``--parallel <jobs>`` option to specify a maximum number of jobs. or ``--parallel <jobs>`` option to specify a maximum number of jobs.
The :envvar:`CMAKE_INSTALL_PARALLEL_LEVEL` environment variable specifies a The :envvar:`CMAKE_INSTALL_PARALLEL_LEVEL` environment variable specifies a
default parallel level if this option is not provided. default parallel level if this option is not provided.

Loading…
Cancel
Save