CaROS/poky
3
1
Fork 0
mirror of https://git.yoctoproject.org/git/poky synced 2026-01-04 16:10:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual, dev-manual: Added CMake toolchain files.

Browse Source 
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: cacdedf4e1186a96ce00f94e0f42817dfb724ac7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2019-10-17 12:09:17 -07:00 committed by Richard Purdie
parent 25b88e7072
commit c1b94791e6
2 changed files with 31 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -2348,7 +2348,7 @@
Most software provides some means of setting build-time
configuration options before compilation.
Typically, setting these options is accomplished by running a
configure script with some options, or by modifying a build
configure script with options, or by modifying a build
configuration file.
<note>
As of Yocto Project Release 1.7, some of the core recipes
@ -2388,6 +2388,7 @@
software is built using Autotools.
If this is the case, you just need to worry about
modifying the configuration.</para>
<para>When using Autotools, your recipe needs to inherit
the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink>
@ -2400,13 +2401,15 @@
or
<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></ulink>
to pass any needed configure options that are specific
to the recipe.</para></listitem>
to the recipe.
</para></listitem>
<listitem><para><emphasis>CMake:</emphasis>
If your source files have a
<filename>CMakeLists.txt</filename> file, then your
software is built using CMake.
If this is the case, you just need to worry about
modifying the configuration.</para>
<para>When you use CMake, your recipe needs to inherit
the
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-cmake'><filename>cmake</filename></ulink>
@ -2416,7 +2419,16 @@
You can make some adjustments by setting
<ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink>
to pass any needed configure options that are specific
to the recipe.</para></listitem>
to the recipe.
<note>
If you need to install one or more custom CMake
toolchain files that are supplied by the
application you are building, install the files to
<filename>${D}${datadir}/cmake/</filename> Modules
during
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>.
</note>
</para></listitem>
<listitem><para><emphasis>Other:</emphasis>
If your source files do not have a
<filename>configure.ac</filename> or
@ -2779,6 +2791,14 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename></ulink>
for additional information.
</para></listitem>
<listitem><para>
If you need to install one or more custom CMake
toolchain files that are supplied by the
application you are building, install the files to
<filename>${D}${datadir}/cmake/</filename> Modules
during
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>.
</para></listitem>
</itemizedlist>
</note>
</section>

8
documentation/ref-manual/ref-classes.xml
View File

@ -445,6 +445,14 @@
variable to specify additional configuration options to be passed
using the <filename>cmake</filename> command line.
</para>
<para>
On the occasion that you would be installing custom CMake toolchain
files supplied by the application being built, you should install them
to the preferred CMake Module directory:
<filename>${D}${datadir}/cmake/</filename> Modules during
<ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-install'><filename>do_install</filename></ulink>.
</para>
</section>
<section id='ref-classes-cml1'>