summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-10-17 12:09:17 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-10-23 17:15:53 +0100
commitff0db7b88ec5026f75a86f6fd8562c35b95b1017 (patch)
tree74cbdb05b44a310bf544d5364d6492a6ea5fefd5
parent20d648416b43631a01de0469c1a9dc952639c98e (diff)
downloadpoky-ff0db7b88ec5026f75a86f6fd8562c35b95b1017.tar.gz
ref-manual, dev-manual: Added CMake toolchain files.
Fixes [YOCTO #12760] Updated the cmake.bbclass description to tell what directory to insall custom CMake toolchain files into. Also, updated the two areas in the "Writing a New Recipe" section that mention CMake. Placed a couple notes there concerning the same directory stuff. (From yocto-docs rev: a65cd2c4c062d4ae388191b9d6708b4fadffaa3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml26
-rw-r--r--documentation/ref-manual/ref-classes.xml8
2 files changed, 31 insertions, 3 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 0dddb8b3bb..00741ee456 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2349,7 +2349,7 @@
2349 Most software provides some means of setting build-time 2349 Most software provides some means of setting build-time
2350 configuration options before compilation. 2350 configuration options before compilation.
2351 Typically, setting these options is accomplished by running a 2351 Typically, setting these options is accomplished by running a
2352 configure script with some options, or by modifying a build 2352 configure script with options, or by modifying a build
2353 configuration file. 2353 configuration file.
2354 <note> 2354 <note>
2355 As of Yocto Project Release 1.7, some of the core recipes 2355 As of Yocto Project Release 1.7, some of the core recipes
@@ -2389,6 +2389,7 @@
2389 software is built using Autotools. 2389 software is built using Autotools.
2390 If this is the case, you just need to worry about 2390 If this is the case, you just need to worry about
2391 modifying the configuration.</para> 2391 modifying the configuration.</para>
2392
2392 <para>When using Autotools, your recipe needs to inherit 2393 <para>When using Autotools, your recipe needs to inherit
2393 the 2394 the
2394 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink> 2395 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink>
@@ -2401,13 +2402,15 @@
2401 or 2402 or
2402 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink> 2403 <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
2403 to pass any needed configure options that are specific 2404 to pass any needed configure options that are specific
2404 to the recipe.</para></listitem> 2405 to the recipe.
2406 </para></listitem>
2405 <listitem><para><emphasis>CMake:</emphasis> 2407 <listitem><para><emphasis>CMake:</emphasis>
2406 If your source files have a 2408 If your source files have a
2407 <filename>CMakeLists.txt</filename> file, then your 2409 <filename>CMakeLists.txt</filename> file, then your
2408 software is built using CMake. 2410 software is built using CMake.
2409 If this is the case, you just need to worry about 2411 If this is the case, you just need to worry about
2410 modifying the configuration.</para> 2412 modifying the configuration.</para>
2413
2411 <para>When you use CMake, your recipe needs to inherit 2414 <para>When you use CMake, your recipe needs to inherit
2412 the 2415 the
2413 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-cmake'><filename>cmake</filename></ulink> 2416 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-cmake'><filename>cmake</filename></ulink>
@@ -2417,7 +2420,16 @@
2417 You can make some adjustments by setting 2420 You can make some adjustments by setting
2418 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink> 2421 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink>
2419 to pass any needed configure options that are specific 2422 to pass any needed configure options that are specific
2420 to the recipe.</para></listitem> 2423 to the recipe.
2424 <note>
2425 If you need to install one or more custom CMake
2426 toolchain files that are supplied by the
2427 application you are building, install the files to
2428 <filename>${D}${datadir}/cmake/</filename> Modules
2429 during
2430 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>.
2431 </note>
2432 </para></listitem>
2421 <listitem><para><emphasis>Other:</emphasis> 2433 <listitem><para><emphasis>Other:</emphasis>
2422 If your source files do not have a 2434 If your source files do not have a
2423 <filename>configure.ac</filename> or 2435 <filename>configure.ac</filename> or
@@ -2780,6 +2792,14 @@
2780 <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename></ulink> 2792 <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename></ulink>
2781 for additional information. 2793 for additional information.
2782 </para></listitem> 2794 </para></listitem>
2795 <listitem><para>
2796 If you need to install one or more custom CMake
2797 toolchain files that are supplied by the
2798 application you are building, install the files to
2799 <filename>${D}${datadir}/cmake/</filename> Modules
2800 during
2801 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>.
2802 </para></listitem>
2783 </itemizedlist> 2803 </itemizedlist>
2784 </note> 2804 </note>
2785 </section> 2805 </section>
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 5403f20b6f..f9bbddd724 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -428,6 +428,14 @@
428 variable to specify additional configuration options to be passed 428 variable to specify additional configuration options to be passed
429 using the <filename>cmake</filename> command line. 429 using the <filename>cmake</filename> command line.
430 </para> 430 </para>
431
432 <para>
433 On the occasion that you would be installing custom CMake toolchain
434 files supplied by the application being built, you should install them
435 to the preferred CMake Module directory:
436 <filename>${D}${datadir}/cmake/</filename> Modules during
437 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>.
438 </para>
431</section> 439</section>
432 440
433<section id='ref-classes-cml1'> 441<section id='ref-classes-cml1'>