diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2018-11-29 09:21:43 -0800 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-12-15 11:48:59 +0000 |
| commit | d29f4dcc457eec633d86e16cf0db632f2ba2f716 (patch) | |
| tree | 1a1b6fb4e197c40b3ac4dc7f81c02e5834d5f1ab /documentation | |
| parent | 32395abc6dc7b2f21a059b4a8677361caa95604b (diff) | |
| download | poky-d29f4dcc457eec633d86e16cf0db632f2ba2f716.tar.gz | |
ref-manual: Updates to CMake and cmake.bbclass.
I cleaned up the terminology used for the CMake build system.
I provided some meaningful links to a good overview page for CMake.
I also built in some cross-referencing as needed.
(From yocto-docs rev: 7c38add39b97a7a8786a1be53f9ff549e4727fad)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/ref-manual/migration.xml | 5 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 9 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 7 |
3 files changed, 14 insertions, 7 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 66a58d11ce..c648d8d442 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml | |||
| @@ -5557,8 +5557,9 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>. | |||
| 5557 | incompatible with other implementations. | 5557 | incompatible with other implementations. |
| 5558 | </para></listitem> | 5558 | </para></listitem> |
| 5559 | <listitem><para> | 5559 | <listitem><para> |
| 5560 | By default, the <filename>cmake</filename> class uses | 5560 | By default, the |
| 5561 | <filename>ninja</filename> instead of | 5561 | <link linkend='ref-classes-cmake'><filename>cmake</filename></link> |
| 5562 | class uses <filename>ninja</filename> instead of | ||
| 5562 | <filename>make</filename> for building. | 5563 | <filename>make</filename> for building. |
| 5563 | This improves build performance. | 5564 | This improves build performance. |
| 5564 | If a recipe is broken with <filename>ninja</filename>, then | 5565 | If a recipe is broken with <filename>ninja</filename>, then |
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 9fef0fc5f7..d602851c54 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -449,12 +449,13 @@ | |||
| 449 | <title><filename>cmake.bbclass</filename></title> | 449 | <title><filename>cmake.bbclass</filename></title> |
| 450 | 450 | ||
| 451 | <para> | 451 | <para> |
| 452 | The <filename>cmake</filename> class allows for | 452 | The <filename>cmake</filename> class allows for recipes that need to |
| 453 | recipes that need to build software using the CMake build system. | 453 | build software using the |
| 454 | <ulink url='https://cmake.org/overview/'>CMake</ulink> build system. | ||
| 454 | You can use the | 455 | You can use the |
| 455 | <link linkend='var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></link> | 456 | <link linkend='var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></link> |
| 456 | variable to specify additional configuration options to be passed on | 457 | variable to specify additional configuration options to be passed |
| 457 | the <filename>cmake</filename> command line. | 458 | using the <filename>cmake</filename> command line. |
| 458 | </para> | 459 | </para> |
| 459 | </section> | 460 | </section> |
| 460 | 461 | ||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 58c5418d16..e1511c5487 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -4633,7 +4633,12 @@ | |||
| 4633 | <glossdef> | 4633 | <glossdef> |
| 4634 | <para role="glossdeffirst"> | 4634 | <para role="glossdeffirst"> |
| 4635 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 4635 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 4636 | Additional <filename>cmake</filename> options. | 4636 | Additional |
| 4637 | <ulink url='https://cmake.org/overview/'>CMake</ulink> | ||
| 4638 | options. | ||
| 4639 | See the | ||
| 4640 | <link linkend='ref-classes-cmake'><filename>cmake</filename></link> | ||
| 4641 | class for additional information. | ||
| 4637 | </para> | 4642 | </para> |
| 4638 | </glossdef> | 4643 | </glossdef> |
| 4639 | </glossentry> | 4644 | </glossentry> |
