summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-11-29 09:21:43 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-12-27 22:54:55 +0000
commitdbc9755027d5d530c89ba4f6e7a2771ee08f3081 (patch)
tree3fb8b4f67168596b14ea235bf7bb5ee594992f58 /documentation
parentd99d261613d2e7aea1d9052b899f183858ecf8b3 (diff)
downloadpoky-dbc9755027d5d530c89ba4f6e7a2771ee08f3081.tar.gz
poky-dbc9755027d5d530c89ba4f6e7a2771ee08f3081.tar.bz2
poky-dbc9755027d5d530c89ba4f6e7a2771ee08f3081.zip
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: 7e825427a2dcef2b91a1bfbf1827b73e034e0974) 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.xml5
-rw-r--r--documentation/ref-manual/ref-classes.xml9
-rw-r--r--documentation/ref-manual/ref-variables.xml7
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>.
incompatible with other implementations.
</para></listitem>
<listitem><para>
- By default, the <filename>cmake</filename> class uses
- <filename>ninja</filename> instead of
+ By default, the
+ <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
+ class uses <filename>ninja</filename> instead of
<filename>make</filename> for building.
This improves build performance.
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 @@
<title><filename>cmake.bbclass</filename></title>
<para>
- The <filename>cmake</filename> class allows for
- recipes that need to build software using the CMake build system.
+ The <filename>cmake</filename> class allows for recipes that need to
+ build software using the
+ <ulink url='https://cmake.org/overview/'>CMake</ulink> build system.
You can use the
<link linkend='var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></link>
- variable to specify additional configuration options to be passed on
- the <filename>cmake</filename> command line.
+ variable to specify additional configuration options to be passed
+ using the <filename>cmake</filename> command line.
</para>
</section>
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 @@
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
- Additional <filename>cmake</filename> options.
+ Additional
+ <ulink url='https://cmake.org/overview/'>CMake</ulink>
+ options.
+ See the
+ <link linkend='ref-classes-cmake'><filename>cmake</filename></link>
+ class for additional information.
</para>
</glossdef>
</glossentry>