diff options
Diffstat (limited to 'documentation/ref-manual/classes.rst')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 25 |
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 | ||
| 349 | The ref:`ref-classes-cmake` class allows for recipes that need to build software using | 349 | The :ref:`ref-classes-cmake` class allows recipes to build software using the |
| 350 | the `CMake <https://cmake.org/overview/>`__ build system. You can use | 350 | `CMake <https://cmake.org/overview/>`__ build system. You can use the |
| 351 | the :term:`EXTRA_OECMAKE` variable to specify | 351 | :term:`EXTRA_OECMAKE` variable to specify additional configuration options to |
| 352 | additional configuration options to be passed using the ``cmake`` | 352 | pass to the ``cmake`` command line. |
| 353 | command line. | 353 | |
| 354 | 354 | By default, the :ref:`ref-classes-cmake` class uses | |
| 355 | On the occasion that you would be installing custom CMake toolchain | 355 | `Ninja <https://ninja-build.org/>`__ instead of GNU make for building, which |
| 356 | files supplied by the application being built, you should install them | 356 | offers better build performance. If a recipe is broken with Ninja, then the |
| 357 | to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` | 357 | recipe can set the :term:`OECMAKE_GENERATOR` variable to ``Unix Makefiles`` to |
| 358 | Modules during | 358 | use GNU make instead. |
| 359 | :ref:`ref-tasks-install`. | 359 | |
| 360 | If you need to install custom CMake toolchain files supplied by the application | ||
| 361 | being built, you should install them (during :ref:`ref-tasks-install`) to the | ||
| 362 | preferred CMake Module directory: ``${D}${datadir}/cmake/modules/``. | ||
| 360 | 363 | ||
| 361 | .. _ref-classes-cml1: | 364 | .. _ref-classes-cml1: |
| 362 | 365 | ||
