summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-02-15 11:37:56 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-02-24 15:43:25 +0000
commit2b621b21bc9d11f38e65a79994ba8c3d36325e90 (patch)
treee07f51a59b284f8b506cfdb3a2866b01764e0b8e /documentation/ref-manual/classes.rst
parent1e14e7cc7999e924d7fb6d32844a95579534251e (diff)
downloadpoky-2b621b21bc9d11f38e65a79994ba8c3d36325e90.tar.gz
ref-manual: classes.rst: improvements to cmake class documentation
- Fix quoting for path to cmake modules - Document OECMAKE_GENERATOR variable - Style simplifications (From yocto-docs rev: ecdc1775e27717ec87442575f65b1f24ca2b0348) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r--documentation/ref-manual/classes.rst25
1 files changed, 14 insertions, 11 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 4fdc4c583e..b9b49981e1 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -346,17 +346,20 @@ in order to make them relocatable.
346``cmake`` 346``cmake``
347========= 347=========
348 348
349The ref:`ref-classes-cmake` class allows for recipes that need to build software using 349The :ref:`ref-classes-cmake` class allows recipes to build software using the
350the `CMake <https://cmake.org/overview/>`__ build system. You can use 350`CMake <https://cmake.org/overview/>`__ build system. You can use the
351the :term:`EXTRA_OECMAKE` variable to specify 351:term:`EXTRA_OECMAKE` variable to specify additional configuration options to
352additional configuration options to be passed using the ``cmake`` 352pass to the ``cmake`` command line.
353command line. 353
354 354By default, the :ref:`ref-classes-cmake` class uses
355On the occasion that you would be installing custom CMake toolchain 355`Ninja <https://ninja-build.org/>`__ instead of GNU make for building, which
356files supplied by the application being built, you should install them 356offers better build performance. If a recipe is broken with Ninja, then the
357to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` 357recipe can set the :term:`OECMAKE_GENERATOR` variable to ``Unix Makefiles`` to
358Modules during 358use GNU make instead.
359:ref:`ref-tasks-install`. 359
360If you need to install custom CMake toolchain files supplied by the application
361being built, you should install them (during :ref:`ref-tasks-install`) to the
362preferred CMake Module directory: ``${D}${datadir}/cmake/modules/``.
360 363
361.. _ref-classes-cml1: 364.. _ref-classes-cml1:
362 365